OrderFulfillmentExpanded Data Type

OrderFulfillmentPrime with embedded fulfillment items. Use this representation to retrieve the full fulfillment detail including individually shipped products.

Available Since
1.3.0
Properties
Name Type Description
items array of OrderFulfillmentItem A historical record of each item in the fulfillment.
Inherited from OrderFulfillment
NameTypeDescription
id number Unique numeric identifier for the OrderFulfillment.
trackingNumber string Tracking numbers provided by the shipping company.
trackingUrl string The URLs of tracking pages for the fulfillment.
name string Display name or label for this fulfillment, typically the carrier service name.
carrier Carrier The shipping company.
OrderFulfillmentExpanded (JSON)
{
  "orderFulfillmentExpanded" : {
    "items" : {
      "orderFulfillmentItem" : [ {
        "id" : 12345,
        "quantity" : 2,
        "item" : {
          "id" : 12345,
          "created" : 12345,
          "assignedProductColor" : { },
          "assignedProductSize" : { },
          "amount" : 2,
          "price" : 9.99,
          "uuid" : "...",
          "customReferenceId" : "Item 123456",
          "customLabel" : "..."
        }
      }, {
        "id" : 12345,
        "quantity" : 2,
        "item" : {
          "id" : 12345,
          "created" : 12345,
          "assignedProductColor" : { },
          "assignedProductSize" : { },
          "amount" : 2,
          "price" : 9.99,
          "uuid" : "...",
          "customReferenceId" : "Item 123456",
          "customLabel" : "..."
        }
      } ]
    },
    "id" : 12345,
    "trackingNumber" : "222201010015732844",
    "trackingUrl" : "https://www.ups.com/track?222201010015732844",
    "name" : "UPS Standard",
    "carrier" : {
      "id" : 12345,
      "name" : "UPS",
      "description" : "Standard domestic shipping method",
      "phoneRequired" : true,
      "moduleProvider" : {
        "id" : 12345,
        "name" : "Standard",
        "provider" : "ups",
        "serviceType" : "standard",
        "moduleType" : { }
      },
      "customProvider" : "...",
      "premium" : true,
      "emdorsement" : "...",
      "ddp" : true,
      "showTicketLogo" : true,
      "customApiUser" : "...",
      "customApiKey" : "...",
      "htmlTemplate" : "...",
      "mainCarrier" : { },
      "perProduct" : true
    }
  }
}
OrderFulfillmentExpanded Data Type

OrderFulfillmentPrime with embedded fulfillment items. Use this representation to retrieve the full fulfillment detail including individually shipped products.

Available Since
1.3.0
Properties
Name Type Description
orderFulfillmentItem list of OrderFulfillmentItem A historical record of each item in the fulfillment.
Inherited from OrderFulfillment
NameTypeDescription
carrier Carrier The shipping company.
id int Unique numeric identifier for the OrderFulfillment.
name string Display name or label for this fulfillment, typically the carrier service name.
trackingNumber string Tracking numbers provided by the shipping company.
trackingUrl string The URLs of tracking pages for the fulfillment.
OrderFulfillmentExpanded (XML)
<orderFulfillmentExpanded>
  <items>
    <orderFulfillmentItem>
      <id>...</id>
      <quantity>2</quantity>
      <item>
        <id>...</id>
        <created>2019-04-25T18:02:07+02:00</created>
        <assignedProductColor/>
        <assignedProductSize/>
        <amount>2</amount>
        <price>9.99</price>
        <uuid>...</uuid>
        <customReferenceId>Item 123456</customReferenceId>
        <customLabel>...</customLabel>
      </item>
    </orderFulfillmentItem>
  </items>
  <id>...</id>
  <trackingNumber>222201010015732844</trackingNumber>
  <trackingUrl>https://www.ups.com/track?222201010015732844</trackingUrl>
  <name>UPS Standard</name>
  <carrier>
    <id>...</id>
    <name>UPS</name>
    <description>Standard domestic shipping method</description>
    <phoneRequired>true</phoneRequired>
    <moduleProvider/>
    <customProvider>...</customProvider>
    <premium>...</premium>
    <emdorsement>...</emdorsement>
    <ddp>...</ddp>
    <showTicketLogo>...</showTicketLogo>
    <customApiUser>...</customApiUser>
    <customApiKey>...</customApiKey>
    <htmlTemplate>...</htmlTemplate>
    <mainCarrier/>
    <perProduct>...</perProduct>
  </carrier>
</orderFulfillmentExpanded>