Download OpenAPI specification:
The Delta International e-commerce API provides developers with an interface to connect their online store to fully automate the ordering process. For access to the API or other questions, please contact your contact person at Delta International.
Returns all orders associated with the API key used to perform the request.
| filter[created_at_min] | string <ISO 8601> Example: filter[created_at_min]=YYYY-MM-DDThh:mm:ss Show orders created after the specified date. |
| filter[created_at_max] | string <ISO 8601> Example: filter[created_at_max]=YYYY-MM-DDThh:mm:ss Show orders created before the specified date. |
| filter[updated_at_min] | string <ISO 8601> Example: filter[updated_at_min]=YYYY-MM-DDThh:mm:ss Show orders last updated after the specified date. |
| filter[updated_at_max] | string <ISO 8601> Example: filter[updated_at_max]=YYYY-MM-DDThh:mm:ss Show orders last updated before the specified date. |
| filter[number_webshop] | string Example: filter[number_webshop]=100123 Show orders by the number of the order in the webshop. |
| sort | string Enum: "number_webshop" "delivery_date" "created_at" "updated_at" Examples:
Used to determine by which property the result will be ordered. Sorting is ascending by default and can be reversed by adding a hyphen (-) to the start of the property name. |
| page | integer Example: page=1 The number of the results page to return. |
| limit | integer Example: limit=50 Specifies the number of resources that a single response page contains. The default, and also the maximum, is a limit of 50 for this endpoint. |
{- "orders": [
- {
- "id": "RGV4MJ14",
- "customer_number": "12345",
- "language_code": "NL",
- "number_webshop": "100123",
- "remarks": "The delivery person can leave the product in the driveway.",
- "shipping_address": {
- "drop_off_point_id": "NL12345",
- "contact_person": "Janssen B.V.",
- "name": "Janssen B.V.",
- "name2": "Jan Janssen",
- "street": "Laakweg",
- "street2": "Appartment 2",
- "number": "172",
- "extension": "A",
- "zipcode": "6041 CV",
- "city": "Roermond",
- "country_code": "NL",
- "phone_one": "+31612345678",
- "phone_two": "+31612345678",
- "email": "jan.janssen@deltainternational.nl"
}, - "lines": [
- {
- "id": "J19NJ2NL",
- "sequence": 1,
- "product_number": "120018",
- "description": "1/2\" Doppenset lang, 18dlg, M-module",
- "quantity": 5,
- "updated_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z"
}
], - "delivery_date": "2019-08-24",
- "updated_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z"
}
], - "links": {
}, - "meta": {
- "current_page": 1,
- "from": 1,
- "last_page": 3,
- "links": [
], - "per_page": 50,
- "to": 50,
- "total": 60
}
}Create an new order associated with the API key used to perform the request.
Create order
object |
{- "order": {
- "customer_number": "12345",
- "language_code": "NL",
- "number_webshop": "100123",
- "remarks": "The delivery person can leave the product in the driveway.",
- "shipping_address": {
- "drop_off_point_id": "ABC123",
- "contact_person": "Delta International",
- "name": "Janssen Gardening",
- "name2": "Jan Janssen",
- "street": "Laakweg",
- "street2": "Appartment 2",
- "number": "172",
- "extension": "A",
- "zipcode": "6041 CV",
- "city": "Roermond",
- "country_code": "NL",
- "phone_one": "+31612345678",
- "phone_two": "+31612345678",
- "email": "jan.janssen@deltainternational.nl"
}, - "lines": [
- {
- "product_number": "TBD-P-100-120-K",
- "quantity": 1
}
], - "delivery_date": "2019-08-24"
}
}{- "order": {
- "id": "RGV4MJ14",
- "customer_number": "12345",
- "language_code": "NL",
- "number_webshop": "100123",
- "remarks": "The delivery person can leave the product in the driveway.",
- "shipping_address": {
- "drop_off_point_id": "NL12345",
- "contact_person": "Janssen B.V.",
- "name": "Janssen B.V.",
- "name2": "Jan Janssen",
- "street": "Laakweg",
- "street2": "Appartment 2",
- "number": "172",
- "extension": "A",
- "zipcode": "6041 CV",
- "city": "Roermond",
- "country_code": "NL",
- "phone_one": "+31612345678",
- "phone_two": "+31612345678",
- "email": "jan.janssen@deltainternational.nl"
}, - "lines": [
- {
- "id": "J19NJ2NL",
- "sequence": 1,
- "product_number": "120018",
- "description": "1/2\" Doppenset lang, 18dlg, M-module",
- "quantity": 5,
- "updated_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z"
}
], - "delivery_date": "2019-08-24",
- "updated_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z"
}
}Returns a single order based on the specified ID in the URL.
| order required | string the ID of the order to retrieve |
{- "order": {
- "id": "RGV4MJ14",
- "customer_number": "12345",
- "language_code": "NL",
- "number_webshop": "100123",
- "remarks": "The delivery person can leave the product in the driveway.",
- "shipping_address": {
- "drop_off_point_id": "NL12345",
- "contact_person": "Janssen B.V.",
- "name": "Janssen B.V.",
- "name2": "Jan Janssen",
- "street": "Laakweg",
- "street2": "Appartment 2",
- "number": "172",
- "extension": "A",
- "zipcode": "6041 CV",
- "city": "Roermond",
- "country_code": "NL",
- "phone_one": "+31612345678",
- "phone_two": "+31612345678",
- "email": "jan.janssen@deltainternational.nl"
}, - "lines": [
- {
- "id": "J19NJ2NL",
- "sequence": 1,
- "product_number": "120018",
- "description": "1/2\" Doppenset lang, 18dlg, M-module",
- "quantity": 5,
- "updated_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z"
}
], - "delivery_date": "2019-08-24",
- "updated_at": "2019-08-24T14:15:22Z",
- "created_at": "2019-08-24T14:15:22Z"
}
}Returns the price and stock for a single article based on the specified product- and customer number.
| customerNumber required | string The ID of the customer to retrieve the article pricing for. |
| articleNumber required | string The ID of the article to retrieve the pricing for. |
{- "article": {
- "code": "Y420333",
- "priceExcl": 183.2,
- "priceIncl": 221.67,
- "isInStock": true,
- "isAlwaysInStock": false,
- "stock": 8,
- "differentials": [
- {
- "amount": 1,
- "priceExcl": 183.2,
- "priceIncl": 221.67
}
]
}
}