Skip to content

Get order ​

Get information of the order from the system. Return fields might be added in the future on request.

Endpoint ​

KeyValue
URLhttps://api.profotonet.nl/v1/order?referenceId=1000000
MethodGET

Response object ​

FieldTypeDescription
referenceIdIntegerYour unique id
testBooleanIf 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 ​

FieldTypeDescription
idObjectIdThe objectid assigned to the order.
orderIdIntegerThe orderid assigned to the order. Set if the order has been downloaded
statusStringThe status assigned to the order.
totalIntegerThe total of the order in cents (tax included).
taxTotalIntegerThe total of the tax of the order in cents.
subTotalIntegerThe subtotal of the order in cents (tax included).
shippingTotalIntegerThe shippingtotal of the order in cents (tax included).
shippingTaxTotalIntegerThe total of the tax of the shipping in cents.
startingCostsTotalIntegerThe startingcoststotal of the order in cents (tax included).
startingCostsTaxTotalIntegerThe total of the tax of the startingscosts in cents.
entryTotalsArrayThe totals per productId of the order.
entryTotals[].productIdIntegerProductId supplied by us.
entryTotals[].quantityIntegerTotal quantity of the cartentries ordered under the productId.
entryTotals[].totalIntegerTotal price of the cartentries ordered under the productId (tax included).
entryTotals[].taxTotalIntegerTotal tax of the cartentries ordered under the productId.
trackAndTraceArrayTrack and trace of the order. The order can be split into several parts with each part having a different code.
trackAndTrace[].codeStringTrack 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"
      }
  ]
}