Procuros Outgoing Transactions API
The Outgoing Transactions API from Procuros — 2 operation(s) for outgoing transactions.
OpenAPI Specification
openapi: 3.0.3
info:
title: Procuros All Transactions Outgoing Transactions API
description: Manage Procuros Transactions.
version: 2.0.0
servers:
- url: https://api.procuros.io/
- url: https://api.procuros-staging.io/
security:
- api_token: []
tags:
- name: Outgoing Transactions
paths:
/v2/transactions:
post:
operationId: v2_send_transaction
summary: Send Transaction
description: Create and send a new transaction to one of your trade partners.
tags:
- Outgoing Transactions
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SentTransaction'
examples:
Order:
value:
type: ORDER
content:
header:
buyer:
name: ACME Co. Ltd.
identifiers:
- identifier: '1100001016310'
domain: GS1
postalAddress:
city: Berlin
countryCode: DE
name: ACME Co. Ltd.
postalCode: '82643'
street: Elroy-Fritsch-Ring 15
contacts:
- firstName: Jane
lastName: Doe
email: jane.doe@example.com
fax: (818) 463-6124
phone: +1.352.856.0626
supplier:
name: Testsupplier
identifiers:
- identifier: '1100001016312'
domain: GS1
shipTo:
identifiers:
- identifier: '1100001016313'
domain: GS1
billTo:
identifiers:
- identifier: '1100001016314'
domain: GS1
orderIdentifier: PO9383-R45
orderDate: '2021-09-30'
AdditionalOrderIdentifiers:
supplierOrderIdentifier: SUP-12345
shipToOrderIdentifier: ST-67890
billToOrderIdentifier: BT-22222
finalRecipientOrderIdentifier: FR-44444
technicalRecipientOrderIdentifier: TR-55555
currency: EUR
requestedDeliveryDate: '2021-10-05'
paymentTerms:
- payInNumberOfDays: 28
percentage: 3
items:
- lineNumber: 1
identifiers:
- identifier: '4300348765432'
domain: GS1
- identifier: PROD-77-LS
domain: BUYER
- identifier: sp_gr_8
domain: SUPPLIER
isDepositItem: false
quantity: 10
unitOfMeasure: EA
description: First product description.
unitPrice: 1.23
tax:
percentage: 7
description: Umsatzsteuer
brand: kela
assortment: ME_GEN
consumerGroup: Unisex
category: '1008'
subCategory: Beverages
modificationGroups:
- modifications:
- type: ALLOWANCE
reasonCode: DISCOUNT
description: Contract trade discount
percentage: 7
Minimal Order:
value:
type: ORDER
content:
header:
buyer:
identifiers:
- identifier: '1100001016310'
domain: GS1
supplier:
identifiers:
- identifier: '1100001016312'
domain: GS1
orderIdentifier: PO9383-R46
orderDate: '2021-09-30'
currency: EUR
requestedDeliveryDate: '2021-10-05'
items:
- lineNumber: 1
identifiers:
- identifier: '4300348765432'
domain: GS1
isDepositItem: false
quantity: 20
unitOfMeasure: EA
- lineNumber: 2
identifiers:
- identifier: '4300348765433'
domain: GS1
isDepositItem: false
quantity: 19
unitOfMeasure: EA
Order Response | ACCEPT:
value:
type: ORDER_RESPONSE
content:
header:
buyer:
name: ACME Co. Ltd.
identifiers:
- identifier: '1100001016310'
domain: GS1
postalAddress:
city: Berlin
countryCode: DE
name: ACME Co. Ltd.
postalCode: '82643'
street: Elroy-Fritsch-Ring 15
contacts:
- firstName: Jane
lastName: Doe
email: jane.doe@example.com
fax: (818) 463-6124
phone: +1.352.856.0626
supplier:
name: Testsupplier
identifiers:
- identifier: '1100001016312'
domain: GS1
shipTo:
identifiers:
- identifier: '1100001016313'
domain: GS1
billTo:
identifiers:
- identifier: '1100001016314'
domain: GS1
type: ACCEPT
orderResponseIdentifier: RE-PO9383-R45
orderResponseDate: '2021-10-01'
orderIdentifier: PO9383-R45
orderDate: '2021-09-30'
AdditionalOrderIdentifiers:
supplierOrderIdentifier: SUP-12345
shipToOrderIdentifier: ST-67890
billToOrderIdentifier: BT-22222
finalRecipientOrderIdentifier: FR-44444
technicalRecipientOrderIdentifier: TR-55555
requestedDeliveryDate: '2021-10-05'
confirmedDeliveryDate: '2021-10-05'
currency: EUR
Order Response | REJECT:
value:
type: ORDER_RESPONSE
content:
header:
buyer:
name: ACME Co. Ltd.
identifiers:
- identifier: '1100001016310'
domain: GS1
postalAddress:
city: Berlin
countryCode: DE
name: ACME Co. Ltd.
postalCode: '82643'
street: Elroy-Fritsch-Ring 15
contacts:
- firstName: Jane
lastName: Doe
email: jane.doe@example.com
fax: (818) 463-6124
phone: +1.352.856.0626
supplier:
name: Testsupplier
identifiers:
- identifier: '1100001016312'
domain: GS1
shipTo:
identifiers:
- identifier: '1100001016313'
domain: GS1
billTo:
identifiers:
- identifier: '1100001016314'
domain: GS1
type: REJECT
orderResponseIdentifier: RE-PO9383-R45
orderResponseDate: '2021-10-01'
orderIdentifier: PO9383-R45
orderDate: '2021-09-30'
AdditionalOrderIdentifiers:
supplierOrderIdentifier: SUP-12345
shipToOrderIdentifier: ST-67890
billToOrderIdentifier: BT-22222
finalRecipientOrderIdentifier: FR-44444
technicalRecipientOrderIdentifier: TR-55555
currency: EUR
comments: Something to comment
Order Response | CHANGE:
value:
type: ORDER_RESPONSE
content:
header:
buyer:
name: ACME Co. Ltd.
identifiers:
- identifier: '1100001016310'
domain: GS1
postalAddress:
city: Berlin
countryCode: DE
name: ACME Co. Ltd.
postalCode: '82643'
street: Elroy-Fritsch-Ring 15
contacts:
- firstName: Jane
lastName: Doe
email: jane.doe@example.com
fax: (818) 463-6124
phone: +1.352.856.0626
supplier:
name: Testsupplier
identifiers:
- identifier: '1100001016312'
domain: GS1
shipTo:
identifiers:
- identifier: '1100001016313'
domain: GS1
billTo:
identifiers:
- identifier: '1100001016314'
domain: GS1
type: CHANGE
orderResponseIdentifier: RE-PO9383-R45
orderResponseDate: '2021-10-01'
orderIdentifier: PO9383-R45
orderDate: '2021-09-30'
AdditionalOrderIdentifiers:
supplierOrderIdentifier: SUP-12345
shipToOrderIdentifier: ST-67890
billToOrderIdentifier: BT-22222
finalRecipientOrderIdentifier: FR-44444
technicalRecipientOrderIdentifier: TR-55555
requestedDeliveryDate: '2021-10-05'
confirmedDeliveryDate: '2021-10-05'
currency: EUR
comments: Something to comment
items:
- lineNumber: 1
identifiers:
- identifier: '4300348765432'
domain: GS1
- identifier: PROD-77-LS
domain: BUYER
- identifier: sp_gr_8
domain: SUPPLIER
isDepositItem: false
orderedQuantity: 20
confirmedQuantity: 15
unitOfMeasure: EA
description: First product description.
unitPrice: 0.15
- lineNumber: 2
identifiers:
- identifier: '4300348765433'
domain: GS1
- identifier: PROD-78-LS
domain: BUYER
- identifier: sp_gr_9
domain: SUPPLIER
isDepositItem: false
orderedQuantity: 19
confirmedQuantity: 19
unitOfMeasure: EA
description: Second product description.
unitPrice: 1.5
Shipping Notice:
value:
type: SHIPPING_NOTICE
content:
header:
buyer:
name: ACME Co. Ltd.
identifiers:
- identifier: '1100001016310'
domain: GS1
postalAddress:
city: Berlin
countryCode: DE
name: ACME Co. Ltd.
postalCode: '82643'
street: Elroy-Fritsch-Ring 15
contacts:
- firstName: Jane
lastName: Doe
email: jane.doe@example.com
fax: (818) 463-6124
phone: +1.352.856.0626
supplier:
name: Testsupplier
identifiers:
- identifier: '1100001016312'
domain: GS1
shipTo:
identifiers:
- identifier: '1100001016313'
domain: GS1
billTo:
identifiers:
- identifier: '1100001016314'
domain: GS1
shippingNoticeIdentifier: SN9383-R45
shippingNoticeDate: '2021-11-24'
orderIdentifier: PO9383-R45
orderDate: '2021-11-20'
AdditionalOrderIdentifiers:
supplierOrderIdentifier: SUP-12345
shipFromOrderIdentifier: SF-11111
shipToOrderIdentifier: ST-67890
billToOrderIdentifier: BT-22222
finalRecipientOrderIdentifier: FR-44444
despatchDate: '2021-11-05'
requestedDeliveryDate: '2021-11-06'
expectedDeliveryDate: '2021-11-06'
carrier: Example Delivery Solution
trackingNumber: b52ea6a7-c2ea-3bfc-a63f-19140d3b3af5
trackingUrl: https://api.procuros.com/example
transportUnits:
- unitIdentifier: '34000000000001'
unitType: EURO_PALLET
containedTradeUnitCount: 10
items:
- lineNumber: 1
orderLineNumber: 1
identifiers:
- identifier: '4300348765432'
domain: GS1
- identifier: PROD-77-LS
domain: BUYER
- identifier: sp_gr_8
domain: SUPPLIER
isDepositItem: false
orderedQuantity: 20
shippedQuantity: 20
description: First product description.
certifications:
deBnn: NUMBER-123
batches:
- batchIdentifier: BATCH_ID_1'
expirationDate: '2022-12-24'
quantity: 15
- batchIdentifier: BATCH_ID_2'
expirationDate: '2022-12-31'
quantity: 5
- lineNumber: 2
orderLineNumber: 2
identifiers:
- identifier: '4300348765433'
domain: GS1
- identifier: PROD-78-LS
domain: BUYER
- identifier: sp_gr_9
domain: SUPPLIER
isDepositItem: false
orderedQuantity: 19
shippedQuantity: 15
openQuantityAction: DISCARDED
batches:
- batchIdentifier: BATCH_ID_2'
expirationDate: '2022-05-01'
quantity: 15
description: Sparkling Water - Crate (6x0.75l).
Invoice:
value:
type: INVOICE
content:
header:
buyer:
name: ACME Co. Ltd.
identifiers:
- identifier: '1100001016310'
domain: GS1
postalAddress:
city: Berlin
countryCode: DE
name: ACME Co. Ltd.
postalCode: '82643'
street: Elroy-Fritsch-Ring 15
contacts:
- firstName: Jane
lastName: Doe
email: jane.doe@example.com
fax: (818) 463-6124
phone: +1.352.856.0626
supplier:
name: Testsupplier
identifiers:
- identifier: '1100001016312'
domain: GS1
shipTo:
identifiers:
- identifier: '1100001016313'
domain: GS1
billTo:
identifiers:
- identifier: '1100001016314'
domain: GS1
invoiceIdentifier: IV9383-R45
invoiceDate: '2021-11-11'
shippingNoticeIdentifier: SN9383-R45
shippingNoticeDate: '2021-11-04'
orderIdentifier: PO9383-R45
orderDate: '2021-11-20'
AdditionalOrderIdentifiers:
supplierOrderIdentifier: SUP-12345
shipToOrderIdentifier: ST-67890
billToOrderIdentifier: BT-22222
billFromOrderIdentifier: BF-33333
finalRecipientOrderIdentifier: FR-44444
paymentTerms:
- payInNumberOfDays: 28
percentage: 3
items:
- lineNumber: 1
identifiers:
- identifier: '4300348765432'
domain: GS1
- identifier: PROD-77-LS
domain: BUYER
- identifier: sp_gr_8
domain: SUPPLIER
isDepositItem: false
quantity: 20
unitPrice: 200
description: First product description.
certifications:
deBnn: NUMBER-123
tax:
amount: 760
percentage: 19
description: Total tax amount.
- lineNumber: 2
identifiers:
- identifier: '4300348765433'
domain: GS1
- identifier: PROD-78-LS
domain: BUYER
- identifier: sp_gr_9
domain: SUPPLIER
isDepositItem: false
quantity: 15
unitPrice: 1.5
description: Second product description.
tax:
amount: 26.775
percentage: 19
description: Total tax amount.
CreditNote:
value:
type: CREDIT_NOTE
content:
header:
buyer:
name: ACME Co. Ltd.
identifiers:
- identifier: '1100001016310'
domain: GS1
postalAddress:
city: Berlin
countryCode: DE
name: ACME Co. Ltd.
postalCode: '82643'
street: Elroy-Fritsch-Ring 15
contacts:
- firstName: Jane
lastName: Doe
email: jane.doe@example.com
fax: (818) 463-6124
phone: +1.352.856.0626
supplier:
name: Testsupplier
identifiers:
- identifier: '1100001016312'
domain: GS1
shipTo:
identifiers:
- identifier: '1100001016313'
domain: GS1
billTo:
identifiers:
- identifier: '1100001016314'
domain: GS1
creditNoteIdentifier: CN9383-R45
creditNoteDate: '2021-11-20'
invoiceIdentifier: IV9383-R45
invoiceDate: '2021-11-11'
shippingNoticeIdentifier: SN9383-R45
shippingNoticeDate: '2021-11-04'
orderIdentifier: PO9383-R45
orderDate: '2021-11-20'
reason: customer refund
paymentTerms:
- payInNumberOfDays: 28
percentage: 3
items:
- lineNumber: 1
identifiers:
- identifier: '4300348765432'
domain: GS1
- identifier: PROD-77-LS
domain: BUYER
- identifier: sp_gr_8
domain: SUPPLIER
isDepositItem: false
quantity: 20
unitPrice: 200
description: First product description.
certifications:
deBnn: NUMBER-123
tax:
amount: 760
percentage: 19
description: Total tax amount.
- lineNumber: 2
identifiers:
- identifier: '4300348765433'
domain: GS1
- identifier: PROD-78-LS
domain: BUYER
- identifier: sp_gr_9
domain: SUPPLIER
isDepositItem: false
quantity: 15
unitPrice: 1.5
description: Second product description.
tax:
amount: 26.775
percentage: 19
description: Total tax amount.
DispatchInstruction:
value:
type: DISPATCH_INSTRUCTION
content:
header:
orderIdentifier: ORDER-123
orderDate: '2022-05-01T18:39:09-08:00'
shipmentIdentifier: SHIPMENT-123
noticeDate: '2022-05-01T18:39:09-08:00'
requestedDeliveryDate: '2022-05-01T18:39:09-08:00'
shipFrom:
name: Foo GmbH
identifiers:
- domain: GS1
identifier: abc
postalAddress:
name: Foo
street: Musterstraße 123
addressExtra: 1st Floor
city: Hamburg
postalCode: '12345'
state: HH
countryCode: DE
contacts:
- firstName: Max
lastName: Muster
phone: +49 12345
mobile: +49 12345
email: foo@bar.com
fax: +49 12345
shipTo:
name: Foo GmbH
identifiers:
- domain: GS1
identifier: abc
postalAddress:
name: Foo
street: Musterstraße 123
addressExtra: 1st Floor
city: Hamburg
postalCode: '12345'
state: HH
countryCode: DE
contacts:
- firstName: Max
lastName: Muster
phone: +49 12345
mobile: +49 12345
email: foo@bar.com
fax: +49 12345
billTo:
name: Foo GmbH
identifiers:
- domain: GS1
identifier: abc
postalAddress:
name: Foo
street: Musterstraße 123
addressExtra: 1st Floor
city: Hamburg
postalCode: '12345'
state: HH
countryCode: DE
contacts:
- firstName: Max
lastName: Muster
phone: +49 12345
mobile: +49 12345
email: foo@bar.com
fax: +49 12345
customer:
name: Foo GmbH
identifiers:
- domain: GS1
identifier: abc
postalAddress:
name: Foo
street: Musterstraße 123
addressExtra: 1st Floor
city: Hamburg
postalCode: '12345'
state: HH
countryCode: DE
contacts:
- firstName: Max
lastName: Muster
phone: +49 12345
mobile: +49 12345
email: foo@bar.com
fax: +49 12345
supplier:
name: Foo GmbH
identifiers:
- domain: GS1
identifier: abc
postalAddress:
name: Foo
street: Musterstraße 123
addressExtra: 1st Floor
city: Hamburg
postalCode: '12345'
state: HH
countryCode: DE
contacts:
- firstName: Max
lastName: Muster
phone: +49 12345
mobile: +49 12345
email: foo@bar.com
fax: +49 12345
comments: Some Comment
items:
- orderLineNumber: 1
shippingNoticeLineNumber: 1
shippedQuantity: 1
orderedQuantity: 1
identifiers:
- domain: GS1
identifier: abc
unitOfMeasure: EA
unitPrice: 1
currency: EUR
description: Some Description
batches:
- batchIdentifier: abc
expirationDate: '2022-12-31'
quantity: 30
openQuantityAction: DISCARDED
DispatchInstructionResponse:
value:
type: DISPATCH_INSTRUCTION_RESPONSE
content:
header:
orderId: null
orderDate: null
shipmentId: '48148'
shippingNoticeIdentifier: SHIPMENT-123
shippingNoticeDate: '2022-10-12T12:53:51.000000Z'
dispatchInstructionResponseDate: '2022-10-12T12:53:51.000000Z'
responseDate: '2022-10-12T12:53:51.000000Z'
shipmentDate: '2022-10-12T12:53:51.000000Z'
requestedDeliveryDate: '2022-10-11T22:00:00.000000Z'
expectedDeliveryDate: '2022-10-11T22:00:00.000000Z'
shipFrom:
name: Foo GmbH
identifiers:
- domain: GS1
identifier: GS1
postalAddress:
name: Foo
street: Musterstraße 123
addressExtra: 1st Floor
city: Hamburg
postalCode: '12345'
state: HH
countryCode: DE
contacts:
- firstName: Max
lastName: Muster
phone: +49 12345
mobile: +49 12345
email: foo@bar.com
fax: +49 12345
shipTo:
name: Foo GmbH
identifiers:
- domain: GS1
identifier: GS1
postalAddress:
name: Foo
street: Musterstraße 123
addressExtra: 1st Floor
city: Hamburg
postalCode: '12345'
state: HH
countryCode: DE
contacts:
- title: Dr.
salutation: Herr
firstName: Max
lastName: Muster
phone: +49 12345
mobile: +49 12345
email: foo@bar.com
fax: +49 12345
billTo:
name: Foo GmbH
identifiers:
- domain: GS1
identifier: GS1
postalAddress:
name: Foo
street: Musterstraße 123
addressExtra: 1st Floor
city: Hamburg
postalCode: '12345'
state: HH
countryCode: DE
contacts:
- title: Dr.
salutation: Herr
firstName: Max
lastName: Muster
# --- truncated at 32 KB (205 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/procuros/refs/heads/main/openapi/procuros-outgoing-transactions-api-openapi.yml