OrderFulfillmentItem Data Type

A single product line item within an order fulfillment. Identifies which ordered product was included in a particular shipment.

Available Since
1.3.0
Properties
Name Type Description
id number Unique numeric identifier for the OrderFulfillmentItem.
quantity number The number of items in the fulfillment.
item OrderedProduct The reference to the order item.
OrderFulfillmentItem (JSON) 
{
  "orderFulfillmentItem" : {
    "id" : 12345,
    "quantity" : 2,
    "item" : {
      "id" : 12345,
      "created" : 12345,
      "assignedProductColor" : {
        "id" : 12345,
        "orderIndex" : 1,
        "productColor" : { },
        "default" : true,
        "active" : true
      },
      "assignedProductSize" : {
        "id" : 12345,
        "orderIndex" : 1,
        "default" : true,
        "productSize" : { },
        "width" : 47.0,
        "height" : 68.0,
        "length" : 12345.0,
        "accuracy" : 12345.0
      },
      "amount" : 2,
      "price" : 9.99,
      "uuid" : "...",
      "customReferenceId" : "Item 123456",
      "customLabel" : "..."
    }
  }
}
OrderFulfillmentItem Data Type

A single product line item within an order fulfillment. Identifies which ordered product was included in a particular shipment.

Available Since
1.3.0
Properties
Name Type Description
id int Unique numeric identifier for the OrderFulfillmentItem.
item OrderedProduct The reference to the order item.
quantity int The number of items in the fulfillment.
OrderFulfillmentItem (XML) 
<orderFulfillmentItem>
  <id>...</id>
  <quantity>2</quantity>
  <item>
    <id>...</id>
    <created>2019-04-25T18:02:07+02:00</created>
    <assignedProductColor>
      <id>...</id>
      <orderIndex>1</orderIndex>
      <productColor/>
      <default>...</default>
      <active>...</active>
    </assignedProductColor>
    <assignedProductSize>
      <id>...</id>
      <orderIndex>1</orderIndex>
      <default>...</default>
      <productSize/>
      <width>47</width>
      <height>68</height>
      <length>...</length>
      <accuracy>...</accuracy>
    </assignedProductSize>
    <amount>2</amount>
    <price>9.99</price>
    <uuid>...</uuid>
    <customReferenceId>Item 123456</customReferenceId>
    <customLabel>...</customLabel>
  </item>
</orderFulfillmentItem>