Skip to main content
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
​
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

​
delivery_address
OrderParty · object
required
​
seller
OrderParty · object
required
​
lines
OrderLine · object[]
required
​
total_amount
PriceRequest · object
required

Total order amount (gross)

​
net_amount
PriceRequest · object
required

Net amount (excluding tax)

​
tax_details
TaxDetail · object[]
required

Tax details

​
expected_delivery_date
string<date-time>

Response

​
message
string
required
Example:

"Order created successfully"

​
transmission_id
string
required
​
string