Getting Started
- Overview
- Quick Start
- API Concepts
Endpoints
- Incoming Transactions
- Outgoing Transactions
- All Transactions
- Tasks
- Misc
List Incoming Transactions
List unprocessed incoming transactions from your trade partners.
curl --request GET \
--url https://api.procuros.io/v2/transactions \
--header 'Authorization: Bearer <token>'{
"hasMore": false,
"perPage": 100,
"count": 3,
"nextCursor": null,
"nextPageUrl": null,
"items": [
{
"procurosTransactionId": "949b2f25-fd9d-4c58-8899-b4dc277f8cf9",
"type": "ORDER",
"content": {
"header": {
"buyer": {
"name": "ACME Co. Ltd.",
"identifiers": [
{
"identifier": "1100001016310",
"domain": "GS1"
}
],
"postalAddress": {
"name": "ACME Co. Ltd.",
"street": "Elroy-Fritsch-Ring 15",
"city": "Berlin",
"countryCode": "DE",
"postalCode": "82643"
},
"contacts": [
{
"firstName": "John",
"lastName": "Doe",
"email": "[email protected]",
"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",
"currency": "EUR",
"requestedDeliveryDate": "2021-10-05",
"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,
"quantity": 20,
"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,
"quantity": 19,
"unitOfMeasure": "EA",
"description": "Sparkling Water - Crate (6x0.75l).",
"unitPrice": 1.5
},
{
"lineNumber": 3,
"identifiers": [
{
"identifier": "4300348765434",
"domain": "GS1"
},
{
"identifier": "PFAND-00B-LS",
"domain": "SUPPLIER"
}
],
"isDepositItem": true,
"quantity": 19,
"unitOfMeasure": "EA",
"description": "Deposit 1x crate + 6x bottles.",
"unitPrice": 3.3
}
]
}
},
{
"procurosTransactionId": "94fe13aa-8c9b-40e5-9937-42b852185858",
"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": "[email protected]",
"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",
"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",
"comments": "Something to comment"
},
"transportUnits": [
{
"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,
"unitPrice": 200,
"description": "First product description."
},
{
"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",
"unitPrice": 1.5,
"description": "Second product description."
}
]
}
]
}
},
{
"procurosTransactionId": "94fe1224-ae01-4587-8155-8e852cbbe75d",
"type": "INVOICE",
"content": {
"header": {
"buyer": {
"name": "ACME Co. Ltd.",
"identifiers": [
{
"identifier": "4522704465331",
"domain": "GS1"
},
{
"identifier": "DE123456789",
"domain": "VAT_DE"
}
],
"postalAddress": {
"city": "Berlin",
"countryCode": "DE",
"name": "ACME Co. Ltd.",
"postalCode": "82643",
"street": "Elroy-Fritsch-Ring 15"
},
"contacts": [
{
"firstName": "Jane",
"lastName": "Doe",
"email": "[email protected]",
"fax": "(818) 463-6124",
"phone": "+1.352.856.0626"
}
]
},
"supplier": {
"name": "Testsupplier",
"identifiers": [
{
"identifier": "4231930775745",
"domain": "GS1"
},
{
"identifier": "DE234567890",
"domain": "VAT_DE"
}
]
},
"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-10",
"paymentTerms": [
{
"payInNumberOfDays": 28,
"percentage": 3
}
],
"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,
"quantity": 20,
"unitPrice": 200,
"description": "First product description.",
"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."
}
}
]
}
}
]
}Authorizations
The API Token of your ERP Connection.
Query Parameters
Type of transaction.
ORDER, ORDER_RESPONSE, SHIPPING_NOTICE, INVOICE, CREDIT_NOTE, DISPATCH_INSTRUCTION, DISPATCH_INSTRUCTION_RESPONSE, RECEIVAL_NOTICE, REMITTANCE_ADVICE, PRODUCT_CATALOG Page cursor
Number of transactions returned per page.
1 <= x <= 100Response
Unique ID assigned to every transaction on the Procuros Network.
"949b2f25-fd9d-4c58-8899-b4dc277f8cf9"
Type of transaction.
ORDER, ORDER_RESPONSE, SHIPPING_NOTICE, INVOICE, CREDIT_NOTE, DISPATCH_INSTRUCTION, DISPATCH_INSTRUCTION_RESPONSE, RECEIVAL_NOTICE, REMITTANCE_ADVICE, PRODUCT_CATALOG A purchase order is a formal request from a buying organization to a supplier to fulfill a contract.
Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted.
Depending on the transaction different properties are required. Only on an invoice a full address is required.
Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted.
Depending on the transaction different properties are required. Only on an invoice a full address is required.
Order number assigned to this purchase order by the buyer.
"PO9383-R45"
"2021-10-23T00:00:00.000000Z"
If this is kept empty, the "buyer" is used as the "shipTo" party.
Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted.
Depending on the transaction different properties are required. Only on an invoice a full address is required.
If this is kept empty, the "buyer" is used as the "billTo" party.
Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted.
Depending on the transaction different properties are required. Only on an invoice a full address is required.
Used in case the shipTo is not the final recipient. Mostly used in dropshipping or cross-docking scenarios.
Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted.
Depending on the transaction different properties are required. Only on an invoice a full address is required.
Type of the order as assigned by sender.
"2021-10-23T00:00:00.000000Z"
ISO 4217 standard three-letter currency code.
"EUR"
Arbitrary human-readable information buyers can send within purchase orders
100000Delivery information for the order.
100000Promotion code applied to the entire order.
255Contract reference for the order.
255The document version number. Subsequent updates should increment this number by 1.
LineNumber attribute may remain constant for any item through updates to the order, therefor lineNumbers may not be consecutive.
1
There must be at least one identifier with domain GS1 or BUYER.
Party identifier within the 'domain' such as EAN/GTIN on GS1 domain, buyer's internal SKU on BUYER domain, etc.
"43000000000011"
Identification system the identifier belongs to.
GS1, BUYER, SUPPLIER If true, the item is a deposit item such as bottle deposit (German: Pfandartikel).
Defaults to 1.
2
Subset of the the UN/CEFACT Unit of Measure Common Codes.
EA, GRM, HUR, KGM, LTR, MLT, MTK, MTR, PCK, SET, CS, CA, DAY, WEE, MON, CT, CQ, CU, BJ, BO, MTQ, PF, BG, RO, TNE, BE, CMT, KMT, PR, TU 4.75
5.25
Promotion code applied to this item.
255Contract reference for this item.
255"2021-10-23T00:00:00.000000Z"
"2021-10-23T00:00:00.000000Z"
"2021-10-23T00:00:00.000000Z"
Delivery grace period in days.
Minimum remaining shelf life in days.
Net weight of the item in grams.
Gross weight of the item in grams.
ISO 3166-1 alpha-2 country code.
Color code of the item.
Color name of the item.
Size of the item.
Dimension of the item.
Harmonized System Code of the item.
Organic Control Point Number of the supplier - OCPN is a unique identifier that verifies that a producer of organic products is adhering to the standards for organic production.
255An FSC number refers to an identification number issued by the Forest Stewardship Council (FSC), an international organization that certifies sustainable forestry practices.
Whether or not more transactions can be fetched on the next page.
Amount of transactions returned per page.
Amount of transactions on the current page.
Supplied to the cursor query parameter. See [Pagination] for more info.
Prebuilt URL to retrieve the next page of transactions.
Was this page helpful?
curl --request GET \
--url https://api.procuros.io/v2/transactions \
--header 'Authorization: Bearer <token>'{
"hasMore": false,
"perPage": 100,
"count": 3,
"nextCursor": null,
"nextPageUrl": null,
"items": [
{
"procurosTransactionId": "949b2f25-fd9d-4c58-8899-b4dc277f8cf9",
"type": "ORDER",
"content": {
"header": {
"buyer": {
"name": "ACME Co. Ltd.",
"identifiers": [
{
"identifier": "1100001016310",
"domain": "GS1"
}
],
"postalAddress": {
"name": "ACME Co. Ltd.",
"street": "Elroy-Fritsch-Ring 15",
"city": "Berlin",
"countryCode": "DE",
"postalCode": "82643"
},
"contacts": [
{
"firstName": "John",
"lastName": "Doe",
"email": "[email protected]",
"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",
"currency": "EUR",
"requestedDeliveryDate": "2021-10-05",
"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,
"quantity": 20,
"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,
"quantity": 19,
"unitOfMeasure": "EA",
"description": "Sparkling Water - Crate (6x0.75l).",
"unitPrice": 1.5
},
{
"lineNumber": 3,
"identifiers": [
{
"identifier": "4300348765434",
"domain": "GS1"
},
{
"identifier": "PFAND-00B-LS",
"domain": "SUPPLIER"
}
],
"isDepositItem": true,
"quantity": 19,
"unitOfMeasure": "EA",
"description": "Deposit 1x crate + 6x bottles.",
"unitPrice": 3.3
}
]
}
},
{
"procurosTransactionId": "94fe13aa-8c9b-40e5-9937-42b852185858",
"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": "[email protected]",
"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",
"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",
"comments": "Something to comment"
},
"transportUnits": [
{
"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,
"unitPrice": 200,
"description": "First product description."
},
{
"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",
"unitPrice": 1.5,
"description": "Second product description."
}
]
}
]
}
},
{
"procurosTransactionId": "94fe1224-ae01-4587-8155-8e852cbbe75d",
"type": "INVOICE",
"content": {
"header": {
"buyer": {
"name": "ACME Co. Ltd.",
"identifiers": [
{
"identifier": "4522704465331",
"domain": "GS1"
},
{
"identifier": "DE123456789",
"domain": "VAT_DE"
}
],
"postalAddress": {
"city": "Berlin",
"countryCode": "DE",
"name": "ACME Co. Ltd.",
"postalCode": "82643",
"street": "Elroy-Fritsch-Ring 15"
},
"contacts": [
{
"firstName": "Jane",
"lastName": "Doe",
"email": "[email protected]",
"fax": "(818) 463-6124",
"phone": "+1.352.856.0626"
}
]
},
"supplier": {
"name": "Testsupplier",
"identifiers": [
{
"identifier": "4231930775745",
"domain": "GS1"
},
{
"identifier": "DE234567890",
"domain": "VAT_DE"
}
]
},
"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-10",
"paymentTerms": [
{
"payInNumberOfDays": 28,
"percentage": 3
}
],
"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,
"quantity": 20,
"unitPrice": 200,
"description": "First product description.",
"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."
}
}
]
}
}
]
}