Appearance
Get order
Get information of the order from the system. Return fields might be added in the future on request.
Endpoint
| Key | Value |
|---|---|
| URL | https://api.profotonet.nl/v1/order?referenceId=1000000 |
| Method | GET |
Response object
| Field | Type | Description |
|---|---|---|
| referenceId | Integer | Your unique id |
| test | Boolean | If you are testing set this to true (add &test=true to the url). If you are not testing you can set this to false or not even include it at all. The API will return testing data, even if the referenceId is an existing one. |
Key / Value overview
| Field | Type | Description |
|---|---|---|
| id | ObjectId | The objectid assigned to the order. |
| orderId | Integer | The orderid assigned to the order. Set if the order has been downloaded |
| status | String | The status assigned to the order. |
| total | Integer | The total of the order in cents (tax included). |
| taxTotal | Integer | The total of the tax of the order in cents. |
| subTotal | Integer | The subtotal of the order in cents (tax included). |
| shippingTotal | Integer | The shippingtotal of the order in cents (tax included). |
| shippingTaxTotal | Integer | The total of the tax of the shipping in cents. |
| startingCostsTotal | Integer | The startingcoststotal of the order in cents (tax included). |
| startingCostsTaxTotal | Integer | The total of the tax of the startingscosts in cents. |
| entryTotals | Array | The totals per productId of the order. |
| entryTotals[].productId | Integer | ProductId supplied by us. |
| entryTotals[].quantity | Integer | Total quantity of the cartentries ordered under the productId. |
| entryTotals[].total | Integer | Total price of the cartentries ordered under the productId (tax included). |
| entryTotals[].taxTotal | Integer | Total tax of the cartentries ordered under the productId. |
| trackAndTrace | Array | Track and trace of the order. The order can be split into several parts with each part having a different code. |
| trackAndTrace[].code | String | Track and trace code of the order (or a part of it). |
Example of a result object
json
{
id: "507f1f77bcf86cd799439011",
orderId: 1000023,
status: "order",
total: 8996,
taxTotal: 1561,
subTotal: 8322,
shippingTotal: 575,
shippingTaxTotal: 100,
startingCostsTotal: 99,
startingCostsTaxTotal: 17,
entryTotals: [
{
productId: 1002201300190001,
quantity: 1,
total: 127,
taxTotal: 22
},
{
productId: 1003705000500003,
quantity: 1,
total: 8195,
taxTotal: 1422
}
],
trackAndTrace: [
{
code: "3SYMFU0000001"
}
]
}