ProducerOrder | | Element | Required | Only 1 | Root element of producer order. |
ProducerOrder | Key | Attribute | Required | Only 1 | Primary unique identifier for a producer order. We recommend you store this value in your internal systems for customer and technical support purposes. |
ProducerOrder | Reference | Attribute | Optional | Only 1 | Secondary identifier for a producer order. Not guaranteed to be unique. |
ProducerOrder | Extra | Element | Required for physical delivery orders. | Only 1 | Extra metadata associated with an order. |
ProducerOrder | Vendor | Element | Required for white label branding | Only 1 | Contains Originator Logo information |
Logo | Uri | Attribute | Required for white label branding | Only 1 | Originator Logo Uri |
Extra | Shipping | Element | Required for physical delivery orders. Will be deprecated in future release. | Only 1 | Contains information related to shipment commitment. |
Extra/Shipping | Method | Attribute | Indicates shipping commitment level. | Only 1 | Code of shipping method. Valid shipping codes are 'FC', 'PM', 'SD', and 'ON'. FC = first class, PM = priority mail, SD = second day, ON = overnight. |
ProducerOrder | SalesOrder | Element | Required | Only 1 | Contains information from the original sales order placed by the business partner's customer. All information should be ignored/not utilized by producer. |
ProducerOrder | Shipping | Element | Required | Only 1 | Contains the order ship-to information. |
ProducerOrder/Shipping | Address | Element | Required | Only 1 | Contains the order ship-to address. |
ProducerOrder/Shipping | Contact | Element | Required | Only 1 | Contains the order ship-to customer details. |
ProducerOrder | OrderLine | Element | Required | 1 or more | Contains information about an order line item and associated digital assets. |
OrderLine | Reference | Attribute | Required | Only 1 | FM internal reference for a producer order line. Uniquely identifies a producer order line within a single producer order. |
OrderLine | Sku | Attribute | Required | Only 1 | Alphanumeric code associated with product being ordered. |
OrderLine | Quantity | Attribute | Required | Only 1 | Units to produce |
OrderLine | Description | Attribute | Required | Only 1 | Description of product sku being ordered. |
OrderLine | Asset | Element | Required | 1 or more | Digital asset/file associated with order line. Number of Asset's depends on the product sku being ordered. |
Asset | Id | Attribute | Required | Only 1 | FM internal ID for a producer order line asset. |
Asset | Sort | Attribute | Required | Only 1 | Specifies ordering of assets for an order item. I.e., some product skus may require a specific ordering of images (e.g., photo books). |
Asset | Type | Attribute | Required | Only 1 | Indicates the general image category. Valid values are 'Raw', 'PDF', and 'Image'. We recommend using the content-type on the download asset HTTP request for determining exact file type. |
Asset | Uri | Attribute | Required | Only 1 | URI to the high-resolution image. |