order

An order is a single request for fulfillment that is submitted to Paxon. An order will be 'converted' into one or more shipments that together consist of the same quantity of products delivered at the consumer.

idinteger

The id is an internally assigned id of an order. Only during and POST v3/orders is it possible to use arbitrary integer value which might be used to cross-reference within the message itself. However the system will not honour any value assigned by external systems.

Example: 24006341

type

Constant value: order

Default value: order

attributes object

externalOrderNumberexternalOrderNumberrequired

The externalOrderNumber as specified during creation of the order.

Possible values: <= 50 characters

Example: #1003-UK

referencestring

Optional field to store an internal reference to the order

orderedOnstring<date>

An optional field to place the date the consumer placed the order, this may be a date in the past. For example when the order was forwarded much later to the shop api.

consumerReferencestring

Optional reference provided by the consumer of this order`

promotionCodestring

Any promotion code the consumer used when placing the order.

Example: BLACKFRIDAY

localelocaleCoderequired

The locale defines (among other things) the language used in communications, inserts and possibly packaging relating to this order. The locale has to be a full locale like en-GB Note that the locale in Paxon is very similar to a browser locale. The documentation section about codes contains a list of valid languages and locales

Possible values: Value must match regular expression ^([a-zA-Z]+(?:-[a-zA-Z]+)?)

Examples:

Example 1
Example 2
Example 3
Example 4

Example: nl-NL

Example: nl-BE

Example: en-GB

Example: fr-BE

emailstring<email>

The email address of the consumer. This email address could be used by Paxon, the carrier o customs in various notification messages regarding the shipments(s) related to this order.

Example: consumer@example.com

phoneNumberphoneNumber

The consumer's phone number which might be used by the carrier or customs to contact the consumer regarding the shipment(s) related to this order.

Possible values: <= 32 characters, Value must match regular expression ^[\d\s\+-\.\\\/]+$

vatNumberstring

fulfillFromwarehouseCode

When provided indicates the warehouse from which each orderItem must be fulfilled. When not provided the system will select the warehouse based on the warehouse strategy configuration for your company. Note that this value can also be set at orderItem-level which supercedes the specification at order-level or the warehouse strategy.

Possible values: [BW, DD, FL, FP, GN, NR]

preferredShippingDatestring<date>

Allows the specification of a future date at which the order is to be shipped.

allowPartialDeliveryboolean

When set to true the order may be split into multiple shipments in case there is insufficient stock to filfill the order in a single shipment or from a single warehouse.

Default value: false

onHoldboolean

When set to true prevents the order from being shipped until released.

Default value: false

metadata object

Allows the specification of arbitrary name-value pairs. note currently only the names 'extra1', 'extra2', 'extra3', 'extra4' and 'extra5' are supported and are linked to functionality (contact support for more information).

extra1string

extra2string

extra3string

extra4string

extra5string

channelIdentifierchannelOrderIdentifier

The channelIdentifier is the (technical) id for the order as assigned by the external channel. For example Shopify, Amazon, Bol, Zalando, etc. may assign a unique id for communication and synchronization purposes.

Possible values: <= 250 characters

Example: 2b55dd3c-b1d4-4107-acd2-56903ae5722b

currencycurrencyCode

Defines the currency of the order and all its orderItems. If omitted, the value EUR is assumed. The currency is used to convert the price of each orderItem to an acceptable currency when a shipment must be declaring its value to customs agencies.

Possible values: >= 3 characters and <= 3 characters, Value must match regular expression [A-Z]{3}

Default value: EUR

Examples:

Example 1
Example 2
Example 3

Example: EUR

Example: GBP

Example: USD

relationships object

orderType objectrequired

Represents a relationship to an orderType resource.

data object

Represents a self-link of an orderType resource.

idinteger

Example: 10045

typestring

Possible values: Value must match regular expression orderType

Default value: orderType

links object

selfstring<uri>

Example: https://shopapi.activeants.nl/v3/orderTypes/10045

orderItems object

Represents a relationship to multiple orderItem resources.

data object[]

Array [

idinteger

The id is the internally assigned id of an orderItem. Only during and POST v3/orders is it possible to use arbitrary integer values to cross-reference within the message itself. However the system will not honour any value assigned by external systems.

Example: 52008118

typerequired

Constant value: orderItem

Default value: orderItem

Example: orderItem

links object

selfstring<uri>

Example: https://shopapi.activeants.nl/v3/orderItems/634006341

]

deliveryAddress objectrequired

Denotes the address and name where the order must be delivered, unless a pickUpPoint has been specified in which case the order will be delivered to the pick-up point instead

data object

Identifies a resource as an address.

idinteger

typerequired

Constant value: address

Default value: address

billingAddress object

Optional address that can be used as billing address. When not provided it is assumed to be the same as the deliveryAddress.

data object

Identifies a resource as an address.

idinteger

typerequired

Constant value: address

Default value: address

pickUpPoint object

Optional: specify the address of the pick-up point in case the order is to be delivered at a pick-up point. Note that the deliveryAddress is still required.

data object

Identifies a resource as an pickUpPoint.

idinteger

typerequired

Constant value: pickUpPoint

Default value: pickUpPoint

preferredShippingMethod object

Optional identifier to the shippingMethod preferred for this order. Note that this method is preferred, but not guaranteed since the method might not be available at the warehouse from where the order might be fulfilled, or the shipment may not be compatible with the preferred method. IMPORTANT: the v3 endpoints use the mainShippingMethodId as returned by the GET settings/get endpoints under /MainShippingMethods/id.

data object

Represents a self-link of a shippingMethod resource.

idinteger

Example: 12

type

Constant value: shippingMethod

links object

selfstring<uri>

Example: https://shopapi.activeants.nl/v3/shippingMethod/12

included object[]

An array of resources included with the order, use the type property to identify the resource's type.

Array [

anyOf

orderItemRelationships
addressAttributes
pickUpPointAttributes
orderAttachmentAttributes

Defines the relationships of the orderItem resource.

idinteger

Example: 52008118

typerequired

Constant value: orderItem

Default value: orderItem

Example: orderItem

attributes object

skuproductSkurequired

SKU (stock keeping unit) of a product used to identify products.

Possible values: >= 2 characters and <= 80 characters, Value must match regular expression ^[\x21-\x7E][\x20-\x7E]*[\x21-\x7E]$

Examples:

Example 1
Example 2
Example 3
Example 4
Example 5

Example: TSH-000-S

Example: 8720874770299

Example: HK-HNTSSTNG 6X

Example: BK-14-LARGE: 31x41x14

Example: TRRE-PSU6*003;2023-10:special

channelIdentifierchannelOrderItemIdentifier

The channelIdentifier is the (technical) id for the orderItem as assigned by the external channel. For example Shopify, Amazon, Bol, Zalando, etc. may assign a unique id for communication and synchronization purposes.

Possible values: <= 250 characters

Example: 338fd344-c902-4b1c-8733-1e7fcd01495a

quantityintegerrequired

fulfillFromwarehouseCode

When specified indicates that the item can only be fulfilled from the indicated warehouse.

Possible values: [BW, DD, FL, FP, GN, NR]

pricenumber

Specifies the price of a single unit of the product as sold to the consumer / recipient. Note that all products sold to consumers and shipped internationally must have a price greater than 0.00, as many customs agencies do not accept negative values. Furthermore, some carriers may impose a minimum price—typically around 1.000 in the order’s currency.

vatnumber

This field represents the VAT percentage that was included in the price. If omitted, the value 0.000 is assumed as the percentage. The value must be between [0.000 and 1.000⟩, with an accuracy of up to three decimal places after the comma.

Possible values: >= 0 and < 1

Default value: 0

Examples:

Example 1
Example 2
Example 3

Example: 0.210

Example: 0.075

Example: 0.190

namestring

The name / description for this product on this orderItem. If no value is provided here, then the name of the product will be used instead whenever a name is required (for example when declaring to customs)

metadata object

Allows the specification of arbitrary name-value pairs. note currently only the names 'extra6' and 'extra7' are supported.

extra6string

extra7string

relationships object

order object

Represents a relationship to an order resource.

data object

Represents a self-link of an order resource.

idinteger

Example: 24006341

type

Constant value: order

Default value: order

links object

selfstring<uri>

Example: https://shopapi.activeants.nl/v3/orders/24006341

product object

Represents a relationship to a product resource.

data object

Represents a self-link of a product resource.

idinteger

The id is an internally assigned id of a product. It is possible to assign an arbitrary value in a POST request to cross-reference within the message itself. However the system will not honour any value assigned by external systems.

Example: 1267733

type

Constant value: product

Default value: product

links object

selfstring<uri>

Example: https://shopapi.activeants.nl/v3/products/1267733

]

links object

selfstring<uri>

Example: https://shopapi.activeants.nl/v3/orders/24006341

order
{
  "id": 24006341,
  "attributes": {
    "externalOrderNumber": "#1003-UK",
    "reference": "string",
    "orderedOn": "2024-07-29",
    "consumerReference": "string",
    "promotionCode": "BLACKFRIDAY",
    "locale": "nl-NL",
    "email": "consumer@example.com",
    "phoneNumber": "string",
    "vatNumber": "string",
    "fulfillFrom": "BW",
    "preferredShippingDate": "2024-07-29",
    "allowPartialDelivery": false,
    "onHold": false,
    "metadata": {
      "extra1": "string",
      "extra2": "string",
      "extra3": "string",
      "extra4": "string",
      "extra5": "string"
    },
    "channelIdentifier": "2b55dd3c-b1d4-4107-acd2-56903ae5722b",
    "currency": "EUR"
  },
  "relationships": {
    "orderType": {
      "data": {
        "id": 10045,
        "type": "orderType",
        "links": {
          "self": "https://shopapi.activeants.nl/v3/orderTypes/10045"
        }
      }
    },
    "orderItems": {
      "data": [
        {
          "id": 52008118,
          "type": "orderItem",
          "links": {
            "self": "https://shopapi.activeants.nl/v3/orderItems/634006341"
          }
        }
      ]
    },
    "deliveryAddress": {
      "data": {
        "id": 0
      }
    },
    "billingAddress": {
      "data": {
        "id": 0
      }
    },
    "pickUpPoint": {
      "data": {
        "id": 0
      }
    },
    "preferredShippingMethod": {
      "data": {
        "id": 12,
        "links": {
          "self": "https://shopapi.activeants.nl/v3/shippingMethod/12"
        }
      }
    }
  },
  "included": [
    {
      "id": 52008118,
      "type": "orderItem",
      "attributes": {
        "sku": "TSH-000-S",
        "channelIdentifier": "338fd344-c902-4b1c-8733-1e7fcd01495a",
        "quantity": 0,
        "fulfillFrom": "BW",
        "price": 0,
        "vat": "0.210",
        "name": "string",
        "metadata": {
          "serviceLevel": "premium",
          "purchases": "140",
          "reference": "#74571"
        }
      },
      "relationships": {
        "order": {
          "data": {
            "id": 24006341,
            "links": {
              "self": "https://shopapi.activeants.nl/v3/orders/24006341"
            }
          }
        },
        "product": {
          "data": {
            "id": 1267733,
            "links": {
              "self": "https://shopapi.activeants.nl/v3/products/1267733"
            }
          }
        }
      }
    },
    {
      "attributes": {
        "company": "Tweede Kamer der Staten-Generaal",
        "street1": "Prinses Irenestraat",
        "street2": "Expeditie 1 – zij-ingang",
        "postcode": "2595 BD",
        "houseNumber": "6",
        "city": "Den Haag",
        "countryCode": "NL"
      }
    },
    {
      "id": 0,
      "attributes": {
        "identifier": "NL-105302",
        "registrationNumber": 9045435454,
        "name": "string",
        "street1": "string",
        "street2": "string",
        "postcode": "string",
        "houseNumber": "string",
        "houseNumberExtension": "string",
        "city": "string",
        "region": "string",
        "countryCode": "NL"
      }
    },
    {
      "id": 52005678,
      "type": "orderAttachment",
      "attributes": {
        "filename": "string",
        "contentType": "application/pdf",
        "printStrategy": "REQUIRED"
      }
    }
  ],
  "links": {
    "self": "https://shopapi.activeants.nl/v3/orders/24006341"
  }
}