Skip to main content

orderAttachment

idinteger

The id is an internally assigned id of an orderAttachment. Only during and POST v3/orders or POST v3/orderAttachments 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: 52005678
typerequired
Constant value: orderAttachment
Default value: orderAttachment
Example: orderAttachment
attributes object
filenamestringrequired
contentTypestringrequired

MIME content type of a content property. This parameter is important because will define the manner in which contents are processed, note however that at the moment only one value is supported: application/pdf

Possible values: [application/pdf]

Default value: application/pdf
printStrategyorderAttachmentPrintStrategy

Defines the strategy to employ when printing the orderAttachement. Defaults to REQUIRED.

valuedescription
REQUIRED(default) Makes the printing of the orderAttachment a required step in the fulfilment of each shipment of the order.
BEST_EFFORTMakes the printing of the orderAttahment optional, meaning that when printing fails for what ever reasons the shipment will not be blocked.

Possible values: [REQUIRED, BEST_EFFORT]

Default value: REQUIRED
Examples:
Example: REQUIRED
relationships object
order object

Represents a relationship to an order resource.

data object

Represents a self-link of an order resource.

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
links object
selfstring<uri>
Example: https://shopapi.activeants.nl/v3/orders/24006341
links object
selfstring<uri>
orderAttachment
{
  "id": 52005678,
  "type": "orderAttachment",
  "attributes": {
    "filename": "string",
    "contentType": "application/pdf",
    "printStrategy": "REQUIRED"
  },
  "relationships": {
    "order": {
      "data": {
        "id": 24006341,
        "links": {
          "self": "https://shopapi.activeants.nl/v3/orders/24006341"
        }
      }
    }
  },
  "links": {
    "self": "string"
  }
}