Create a new order

Create a new order

curl --request POST \
  --url http://localhost/api/orders \
  --header 'Content-Type: application/json' \
  --data '
{
  "identification": {
    "seller": {
      "pink_id": "<string>",
      "gln": "<string>"
    },
    "buyer": {
      "pink_id": "<string>",
      "gln": "<string>"
    },
    "pink_id": "<string>",
    "buyer_order_id": "<string>",
    "seller_order_id": "<string>"
  },
  "type": "purchase_order",
  "order_date": "2023-11-07T05:31:56Z",
  "currency": "EUR",
  "buyer": {
    "name": "<string>",
    "address": {
      "line1": "<string>",
      "city": "<string>",
      "postal_code": "<string>",
      "country": "AT",
      "line2": "<string>"
    },
    "identification": {
      "gln": "<string>",
      "tax_id": "<string>"
    },
    "contact_person": "<string>",
    "email": "[email protected]",
    "phone": "<string>"
  },
  "delivery_address": {
    "name": "<string>",
    "address": {
      "line1": "<string>",
      "city": "<string>",
      "postal_code": "<string>",
      "country": "AT",
      "line2": "<string>"
    },
    "identification": {
      "gln": "<string>",
      "tax_id": "<string>"
    },
    "contact_person": "<string>",
    "email": "[email protected]",
    "phone": "<string>"
  },
  "seller": {
    "name": "<string>",
    "address": {
      "line1": "<string>",
      "city": "<string>",
      "postal_code": "<string>",
      "country": "AT",
      "line2": "<string>"
    },
    "identification": {
      "gln": "<string>",
      "tax_id": "<string>"
    },
    "contact_person": "<string>",
    "email": "[email protected]",
    "phone": "<string>"
  },
  "lines": [
    {
      "line_number": "<string>",
      "product_id": "<string>",
      "product_name": "<string>",
      "quantity": 123,
      "unit": "pc",
      "unit_price": {
        "amount": 123,
        "currency": "EUR"
      },
      "total_amount": {
        "amount": 123,
        "currency": "EUR"
      },
      "net_amount": {
        "amount": 123,
        "currency": "EUR"
      },
      "tax_details": {
        "rate": 123,
        "amount": {
          "amount": 123,
          "currency": "EUR"
        },
        "type": "<string>",
        "taxable_amount": {
          "amount": 123,
          "currency": "EUR"
        }
      },
      "expected_delivery_date": "2023-11-07T05:31:56Z"
    }
  ],
  "total_amount": {
    "amount": 123,
    "currency": "EUR"
  },
  "net_amount": {
    "amount": 123,
    "currency": "EUR"
  },
  "tax_details": [
    {
      "rate": 123,
      "amount": {
        "amount": 123,
        "currency": "EUR"
      },
      "type": "<string>",
      "taxable_amount": {
        "amount": 123,
        "currency": "EUR"
      }
    }
  ],
  "expected_delivery_date": "2023-11-07T05:31:56Z"
}
'

{
  "message": "Order created successfully",
  "transmission_id": "<string>",
  "": "<string>"
}

POST

orders

Create a new order

curl --request POST \
  --url http://localhost/api/orders \
  --header 'Content-Type: application/json' \
  --data '
{
  "identification": {
    "seller": {
      "pink_id": "<string>",
      "gln": "<string>"
    },
    "buyer": {
      "pink_id": "<string>",
      "gln": "<string>"
    },
    "pink_id": "<string>",
    "buyer_order_id": "<string>",
    "seller_order_id": "<string>"
  },
  "type": "purchase_order",
  "order_date": "2023-11-07T05:31:56Z",
  "currency": "EUR",
  "buyer": {
    "name": "<string>",
    "address": {
      "line1": "<string>",
      "city": "<string>",
      "postal_code": "<string>",
      "country": "AT",
      "line2": "<string>"
    },
    "identification": {
      "gln": "<string>",
      "tax_id": "<string>"
    },
    "contact_person": "<string>",
    "email": "[email protected]",
    "phone": "<string>"
  },
  "delivery_address": {
    "name": "<string>",
    "address": {
      "line1": "<string>",
      "city": "<string>",
      "postal_code": "<string>",
      "country": "AT",
      "line2": "<string>"
    },
    "identification": {
      "gln": "<string>",
      "tax_id": "<string>"
    },
    "contact_person": "<string>",
    "email": "[email protected]",
    "phone": "<string>"
  },
  "seller": {
    "name": "<string>",
    "address": {
      "line1": "<string>",
      "city": "<string>",
      "postal_code": "<string>",
      "country": "AT",
      "line2": "<string>"
    },
    "identification": {
      "gln": "<string>",
      "tax_id": "<string>"
    },
    "contact_person": "<string>",
    "email": "[email protected]",
    "phone": "<string>"
  },
  "lines": [
    {
      "line_number": "<string>",
      "product_id": "<string>",
      "product_name": "<string>",
      "quantity": 123,
      "unit": "pc",
      "unit_price": {
        "amount": 123,
        "currency": "EUR"
      },
      "total_amount": {
        "amount": 123,
        "currency": "EUR"
      },
      "net_amount": {
        "amount": 123,
        "currency": "EUR"
      },
      "tax_details": {
        "rate": 123,
        "amount": {
          "amount": 123,
          "currency": "EUR"
        },
        "type": "<string>",
        "taxable_amount": {
          "amount": 123,
          "currency": "EUR"
        }
      },
      "expected_delivery_date": "2023-11-07T05:31:56Z"
    }
  ],
  "total_amount": {
    "amount": 123,
    "currency": "EUR"
  },
  "net_amount": {
    "amount": 123,
    "currency": "EUR"
  },
  "tax_details": [
    {
      "rate": 123,
      "amount": {
        "amount": 123,
        "currency": "EUR"
      },
      "type": "<string>",
      "taxable_amount": {
        "amount": 123,
        "currency": "EUR"
      }
    }
  ],
  "expected_delivery_date": "2023-11-07T05:31:56Z"
}
'

{
  "message": "Order created successfully",
  "transmission_id": "<string>",
  "": "<string>"
}

Body

application/json

Order

identification

OrderIdentification · object

required

Show child attributes

identification.seller

PartnerIdentification · object

required

Seller identification

Show child attributes

identification.seller.pink_id

string

Internal platform UUID

identification.seller.gln

string

Global Location Number (GLN)

identification.buyer

PartnerIdentification · object

required

Buyer identification

Show child attributes

identification.buyer.pink_id

string

Internal platform UUID

identification.buyer.gln

string

Global Location Number (GLN)

identification.pink_id

string

Internal platform UUID

identification.buyer_order_id

string

The order number from the buyer's system

identification.seller_order_id

string

The order number from the seller's system

type

enum<string>

required

Available options:

purchase_order,

sales_order

order_date

string<date-time>

required

currency

enum<string>

required

Available options:

EUR,

USD,

GBP

buyer

OrderParty · object

required

Buyer information

Show child attributes

buyer.name

string

required

buyer.address

Address · object

required

Show child attributes

buyer.address.line1

string

required

Address line 1 (e.g., street name and number)

buyer.address.city

string

required

City name

buyer.address.postal_code

string

required

buyer.address.country

enum<string>

required

Available options:

AT,

BE,

BG,

HR,

CY,

CZ,

DK,

EE,

FI,

FR,

DE,

GR,

HU,

IE,

IT,

LV,

LT,

LU,

MT,

NL,

PL,

PT,

RO,

SK,

SI,

ES,

SE,

AL,

AD,

BY,

BA,

IS,

LI,

MD,

MC,

ME,

MK,

NO,

RU,

SM,

RS,

CH,

TR,

UA,

GB,

VA

buyer.address.line2

string

Address line 2 (e.g., apartment, suite, unit, building)

buyer.identification

OrderPartyIdentification · object

Show child attributes

buyer.identification.gln

string

Global Location Number (GLN)

buyer.identification.tax_id

string

Tax identification number (e.g., VAT number)

buyer.contact_person

string

Contact person name

buyer.email

string<email>

Contact email

buyer.phone

string

Contact phone

delivery_address

OrderParty · object

required

Show child attributes

delivery_address.name

string

required

delivery_address.address

Address · object

required

Show child attributes

delivery_address.address.line1

string

required

Address line 1 (e.g., street name and number)

delivery_address.address.city

string

required

City name

delivery_address.address.postal_code

string

required

delivery_address.address.country

enum<string>

required

Available options:

AT,

BE,

BG,

HR,

CY,

CZ,

DK,

EE,

FI,

FR,

DE,

GR,

HU,

IE,

IT,

LV,

LT,

LU,

MT,

NL,

PL,

PT,

RO,

SK,

SI,

ES,

SE,

AL,

AD,

BY,

BA,

IS,

LI,

MD,

MC,

ME,

MK,

NO,

RU,

SM,

RS,

CH,

TR,

UA,

GB,

VA

delivery_address.address.line2

string

Address line 2 (e.g., apartment, suite, unit, building)

delivery_address.identification

OrderPartyIdentification · object

Show child attributes

delivery_address.identification.gln

string

Global Location Number (GLN)

delivery_address.identification.tax_id

string

Tax identification number (e.g., VAT number)

delivery_address.contact_person

string

Contact person name

delivery_address.email

string<email>

Contact email

delivery_address.phone

string

Contact phone

seller

OrderParty · object

required

Show child attributes

seller.name

string

required

seller.address

Address · object

required

Show child attributes

seller.address.line1

string

required

Address line 1 (e.g., street name and number)

seller.address.city

string

required

City name

seller.address.postal_code

string

required

seller.address.country

enum<string>

required

Available options:

AT,

BE,

BG,

HR,

CY,

CZ,

DK,

EE,

FI,

FR,

DE,

GR,

HU,

IE,

IT,

LV,

LT,

LU,

MT,

NL,

PL,

PT,

RO,

SK,

SI,

ES,

SE,

AL,

AD,

BY,

BA,

IS,

LI,

MD,

MC,

ME,

MK,

NO,

RU,

SM,

RS,

CH,

TR,

UA,

GB,

VA

seller.address.line2

string

Address line 2 (e.g., apartment, suite, unit, building)

seller.identification

OrderPartyIdentification · object

Show child attributes

seller.identification.gln

string

Global Location Number (GLN)

seller.identification.tax_id

string

Tax identification number (e.g., VAT number)

seller.contact_person

string

Contact person name

seller.email

string<email>

Contact email

seller.phone

string

Contact phone

lines

OrderLine · object[]

required

Show child attributes

lines.line_number

string

required

lines.product_id

string

required

lines.product_name

string

required

lines.quantity

number

required

lines.unit

enum<string>

required

Available options:

pc,

box,

ctn,

plt,

pack,

bundle,

kg,

g,

mg,

t,

l,

ml,

m3

lines.unit_price

Price · object

Show child attributes

lines.unit_price.amount

integer

required

Amount in the smallest currency unit (e.g., cents for EUR)

lines.unit_price.currency

enum<string>

required

Available options:

EUR,

USD,

GBP

lines.total_amount

Price · object

Show child attributes

lines.total_amount.amount

integer

required

Amount in the smallest currency unit (e.g., cents for EUR)

lines.total_amount.currency

enum<string>

required

Available options:

EUR,

USD,

GBP

lines.net_amount

Price · object

Show child attributes

lines.net_amount.amount

integer

required

Amount in the smallest currency unit (e.g., cents for EUR)

lines.net_amount.currency

enum<string>

required

Available options:

EUR,

USD,

GBP

lines.tax_details

TaxDetail · object

Show child attributes

lines.tax_details.rate

number

required

Tax rate percentage

lines.tax_details.amount

Price · object

required

Show child attributes

lines.tax_details.amount.amount

integer

required

Amount in the smallest currency unit (e.g., cents for EUR)

lines.tax_details.amount.currency

enum<string>

required

Available options:

EUR,

USD,

GBP

lines.tax_details.type

string

Tax type (e.g., VAT)

lines.tax_details.taxable_amount

Price · object

Taxable basis amount

Show child attributes

lines.tax_details.taxable_amount.amount

integer

required

Amount in the smallest currency unit (e.g., cents for EUR)

lines.tax_details.taxable_amount.currency

enum<string>

required

Available options:

EUR,

USD,

GBP

lines.expected_delivery_date

string<date-time>

total_amount

PriceRequest · object

required

Total order amount (gross)

Show child attributes

total_amount.amount

integer

required

Amount in the smallest currency unit (e.g., cents for EUR)

total_amount.currency

enum<string>

required

Available options:

EUR,

USD,

GBP

net_amount

PriceRequest · object

required

Net amount (excluding tax)

Show child attributes

net_amount.amount

integer

required

Amount in the smallest currency unit (e.g., cents for EUR)

net_amount.currency

enum<string>

required

Available options:

EUR,

USD,

GBP

tax_details

TaxDetail · object[]

required

Tax details

Show child attributes

tax_details.rate

number

required

Tax rate percentage

tax_details.amount

Price · object

required

Show child attributes

tax_details.amount.amount

integer

required

Amount in the smallest currency unit (e.g., cents for EUR)

tax_details.amount.currency

enum<string>

required

Available options:

EUR,

USD,

GBP

tax_details.type

string

Tax type (e.g., VAT)

tax_details.taxable_amount

Price · object

Taxable basis amount

Show child attributes

tax_details.taxable_amount.amount

integer

required

Amount in the smallest currency unit (e.g., cents for EUR)

tax_details.taxable_amount.currency

enum<string>

required

Available options:

EUR,

USD,

GBP

expected_delivery_date

string<date-time>

Response

message

string

required

Example:

"Order created successfully"

transmission_id

string

required

string

Create a new invoice Get all pending transmissions

⌘I

Guides

Endpoints

Body

Response