Send Transaction

POST

transactions

curl --request POST \
  --url https://api.procuros.io/v2/transactions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "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": "[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"
    },
    "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": "Second product description.",
        "unitPrice": 1.5
      }
    ]
  }
}'

{
  "procurosTransactionId": "949b2f25-fd9d-4c58-8899-b4dc277f8cf9"
}

Authorizations

Authorization

string

header

required

The API Token of your ERP Connection.

Body

application/json

type

enum<string>

required

Type of transaction.

Available options:

ORDER,

ORDER_RESPONSE,

SHIPPING_NOTICE,

INVOICE,

CREDIT_NOTE,

DISPATCH_INSTRUCTION,

DISPATCH_INSTRUCTION_RESPONSE,

RECEIVAL_NOTICE,

REMITTANCE_ADVICE,

PRODUCT_CATALOG

content

object

required

A purchase order is a formal request from a buying organization to a supplier to fulfill a contract.

content.header

object

required

content.header.buyer

object

required

content.header.buyer.identifiers

object[]

required

content.header.buyer.name

string

Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted.

content.header.buyer.postalAddress

object

Depending on the transaction different properties are required. Only on an invoice a full address is required.

content.header.buyer.contacts

object[]

content.header.buyer.financialInstitution

object

content.header.supplier

object

required

content.header.supplier.identifiers

object[]

required

content.header.supplier.name

string

Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted.

content.header.supplier.postalAddress

object

Depending on the transaction different properties are required. Only on an invoice a full address is required.

content.header.supplier.contacts

object[]

content.header.supplier.financialInstitution

object

content.header.orderIdentifier

string

required

Order number assigned to this purchase order by the buyer.

Example:

"PO9383-R45"

content.header.orderDate

string

required

Example:

"2021-10-23T00:00:00.000000Z"

content.header.shipTo

object

If this is kept empty, the "buyer" is used as the "shipTo" party.

content.header.shipTo.identifiers

object[]

required

content.header.shipTo.name

string

Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted.

content.header.shipTo.postalAddress

object

Depending on the transaction different properties are required. Only on an invoice a full address is required.

content.header.shipTo.contacts

object[]

content.header.shipTo.financialInstitution

object

content.header.billTo

object

If this is kept empty, the "buyer" is used as the "billTo" party.

content.header.billTo.identifiers

object[]

required

content.header.billTo.name

string

Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted.

content.header.billTo.postalAddress

object

Depending on the transaction different properties are required. Only on an invoice a full address is required.

content.header.billTo.contacts

object[]

content.header.billTo.financialInstitution

object

content.header.finalRecipient

object

Used in case the shipTo is not the final recipient. Mostly used in dropshipping or cross-docking scenarios.

content.header.finalRecipient.identifiers

object[]

required

content.header.finalRecipient.name

string

Mandatory if the deprecated "name" attribute on the "PostalAddress" object is omitted.

content.header.finalRecipient.postalAddress

object

Depending on the transaction different properties are required. Only on an invoice a full address is required.

content.header.finalRecipient.contacts

object[]

content.header.finalRecipient.financialInstitution

object

content.header.type

string

Type of the order as assigned by sender.

content.header.requestedDeliveryDate

string

Example:

"2021-10-23T00:00:00.000000Z"

content.header.currency

string

ISO 4217 standard three-letter currency code.

Example:

"EUR"

content.header.comments

string

Arbitrary human-readable information buyers can send within purchase orders

Maximum length: 100000

content.header.deliveryInformation

string

Delivery information for the order.

Maximum length: 100000

content.header.promotionCode

string

Promotion code applied to the entire order.

Maximum length: 255

content.header.contractReference

string

Contract reference for the order.

Maximum length: 255

content.header.version

integer

The document version number. Subsequent updates should increment this number by 1.

content.header.attachments

object[]

content.header.customProperties

object

content.items

object[]

required

content.items.lineNumber

integer

LineNumber attribute may remain constant for any item through updates to the order, therefor lineNumbers may not be consecutive.

Example:

1

content.items.identifiers

object[]

There must be at least one identifier with domain GS1 or BUYER.

content.items.isDepositItem

boolean

If true, the item is a deposit item such as bottle deposit (German: Pfandartikel).

content.items.quantity

number

Defaults to 1.

Example:

2

content.items.unitOfMeasure

enum<string>

default:EA

Subset of the the UN/CEFACT Unit of Measure Common Codes.

Available options:

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

content.items.description

string

content.items.comments

string

content.items.unitPrice

number

Example:

4.75

content.items.recommendedRetailPrice

number

Example:

5.25

content.items.tax

object

content.items.promotionCode

string

Promotion code applied to this item.

Maximum length: 255

content.items.contractReference

string

Contract reference for this item.

Maximum length: 255

content.items.requestedDeliveryDate

string

Example:

"2021-10-23T00:00:00.000000Z"

content.items.requestedEarliestDeliveryDate

string

Example:

"2021-10-23T00:00:00.000000Z"

content.items.requestedLatestDeliveryDate

string

Example:

"2021-10-23T00:00:00.000000Z"

content.items.deliveryGracePeriodInDays

integer

Delivery grace period in days.

content.items.minimumRemainingShelfLifeInDays

integer

Minimum remaining shelf life in days.

content.items.netWeight

number

Net weight of the item in grams.

content.items.grossWeight

number

Gross weight of the item in grams.

content.items.originCountryCode

string

ISO 3166-1 alpha-2 country code.

content.items.colorCode

string

Color code of the item.

content.items.colorName

string

Color name of the item.

content.items.size

string

Size of the item.

content.items.dimension

string

Dimension of the item.

content.items.hsCode

string

Harmonized System Code of the item.

content.items.organicControlPointNumber

string

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.

Maximum length: 255

content.items.fscNumber

string

An FSC number refers to an identification number issued by the Forest Stewardship Council (FSC), an international organization that certifies sustainable forestry practices.

content.items.customProperties

object

Response

201

application/json

Created

procurosTransactionId

string

required

Unique ID assigned to every transaction on the Procuros Network.

Example:

"949b2f25-fd9d-4c58-8899-b4dc277f8cf9"

Was this page helpful?

Bulk Mark Transactions Processed Report Outgoing Error

curl --request POST \
  --url https://api.procuros.io/v2/transactions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "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": "[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"
    },
    "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": "Second product description.",
        "unitPrice": 1.5
      }
    ]
  }
}'

{
  "procurosTransactionId": "949b2f25-fd9d-4c58-8899-b4dc277f8cf9"
}

Getting Started

Endpoints

Guides

Authorizations

Body

Response