Orders API

List orders

Get a list of your orders. Orders are sorted in ascending order by the desired delivery date.

Scope: Orders Overview

GET /orders

Attribute Type Required Description
sort string or array of strings no Sort the orders by the given field or fields.
search string no Search by quote_number, sales_order_number, production_order_number, production_dossier, customer_quote_number, customer_order_number, part_code or customer_part_code
include string or array of strings no List of resources that will be included in the response. Available options: shipments & invoices
Example of response 
[
	{
		"quote_number": "BVF21-0123",
		"sales_order_number": "BVR21-0123",
		"production_order_number": "BPR21-0123",
		"production_dossier": "BPD21-0123",
		"customer_quote_number": "",
		"customer_order_number": "",
		"part_number": "M0001A",
		"customer_part_number": "",
		"revision": "001",
		"qty": 1000,
		"description": "Order Description",
		"desired_delivery_date": "2021-01-01T23:00:00.000000Z",
		"delivered_qty": 500,
		"sales_status": {
			"status_code": "50",
			"description": "Order confirmed"
		},
		"production_status": {
			"status_code": "73",
			"description": "Cleaning"
		},
		"latest_update": "2021-01-01T10:00:00.000000Z",
		"shipments": [
            {
                "shipping_number": "E210001",
                "shipping_date": "2021-01-01T23:00:00.000000Z",
                "qty": 1000,
                "tracking_codes": [
                    "12345678901234567890"
                ]
            }
        ],
        "invoices": [
            {
                "invoice_number": "I210001",
                "invoice_date": "2021-01-01T23:00:00.000000Z",
                "currency": "EUR",
                "subtotal": 5000,
                "total": 6050
            }
        ]
	}
]

Get single order

Get a specific order by its production dossier.

Scope: Orders Overview

GET /orders/:production_dossier

Attribute Type Required Description
include string or array of strings no List of resources that will be included in the response. Available options: shipments & invoices
Example of response 
{
    "quote_number": "BVF21-0123",
    "sales_order_number": "BVR21-0123",
    "production_order_number": "BPR21-0123",
    "production_dossier": "BPD21-0123",
    "customer_quote_number": "",
    "customer_order_number": "",
    "part_number": "M0001A",
    "customer_part_number": "",
    "revision": "001",
    "qty": 1000,
    "description": "Order Description",
    "desired_delivery_date": "2021-01-01T23:00:00.000000Z",
    "delivered_qty": 500,
    "sales_status": {
        "status_code": "50",
        "description": "Order confirmed"
    },
    "production_status": {
        "status_code": "73",
        "description": "Cleaning"
    },
    "latest_update": "2021-01-01T10:00:00.000000Z",
    "shipments": [
        {
            "shipping_number": "E210001",
            "shipping_date": "2021-01-01T23:00:00.000000Z",
            "qty": 1000,
            "tracking_codes": [
                "12345678901234567890"
            ]
        }
    ],
    "invoices": [
        {
            "invoice_number": "I210001",
            "invoice_date": "2021-01-01T23:00:00.000000Z",
            "currency": "EUR",
            "subtotal": 5000,
            "total": 6050
        }
    ]
}

List historical orders

Get a list of your orders. Orders are sorted in ascending order by the delivery date.

Scope: Historical Orders

GET /historical-orders

Attribute Type Required Description
sort string or array of strings no Sort the orders by the given field or fields.
search string no Search by quote_number, sales_order_number, production_order_number, production_dossier, customer_quote_number, customer_order_number, part_code or customer_part_code
include string or array of strings no List of resources that will be included in the response. Available options: shipments & invoices
Example of response 
[
    {
        "quote_number": "BVF21-0123",
        "sales_order_number": "BVR21-0123",
        "production_order_number": "BPR21-0123",
        "production_dossier": "BPD21-0123",
        "customer_quote_number": "",
        "customer_order_number": "",
        "part_number": "M0001A",
        "customer_part_number": "",
        "revision": "001",
        "description": "Order description",
        "delivery_date": "2021-01-01T23:00:00.000000Z",
        "ordered_qty": 1000,
        "delivered_qty": 1000,
        "latest_update": "2021-01-01T23:00:00.000000Z",
        "shipments": [
		  {
			  "shipping_number": "E210001",
			  "shipping_date": "2021-01-01T23:00:00.000000Z",
			  "qty": 1000,
			  "tracking_codes": [
				  "12345678901234567890"
			  ]
		  }
        ],
        "invoices": [
            {
                "invoice_number": "I210001",
                "invoice_date": "2021-01-01T23:00:00.000000Z",
                "currency": "EUR",
                "subtotal": 5000,
                "total": 6050
            }
        ]
    }
]

Get single historical order

Get a specific historical order by its production dossier.

Scope: Historical Orders

GET /historical-orders/:production_dossier

Attribute Type Required Description
include string or array of strings no List of resources that will be included in the response. Available options: shipments & invoices
Example of response 
{
    "quote_number": "BVF21-0123",
    "sales_order_number": "BVR21-0123",
    "production_order_number": "BPR21-0123",
    "production_dossier": "BPD21-0123",
    "customer_quote_number": "",
    "customer_order_number": "",
    "part_number": "M0001A",
    "customer_part_number": "",
    "revision": "001",
    "description": "Order description",
    "delivery_date": "2021-01-01T23:00:00.000000Z",
    "ordered_qty": 1000,
    "delivered_qty": 1000,
    "latest_update": "2021-01-01T23:00:00.000000Z",
    "shipments": [
        {
            "shipping_number": "E210001",
            "shipping_date": "2021-01-01T23:00:00.000000Z",
            "qty": 1000,
            "tracking_codes": [
                "12345678901234567890"
            ]
        }
    ],
    "invoices": [
        {
            "invoice_number": "I210001",
            "invoice_date": "2021-01-01T23:00:00.000000Z",
            "currency": "EUR",
            "subtotal": 5000,
            "total": 6050
        }
    ]
}

Get order statistics

Get statistical information regarding all orders

Scope: Order Statistics

GET /order-statistics

Attribute Type Required Description
sort string or array of strings no Sort the orders by the given field or fields.
Example of response 
[
    {
        "part_number": "M0001",
        "customer_part_number": "",
        "description": "Product description",
        "delivered_qty": 125000,
        "latest_shipping_date": "2021-01-01T00:00:00.000000Z"
    }
]