API Integration: Multiple Units Shipping on a Single Tracking Number

Occasionally you might get an order which contains multiple units, and you will want to confirm that all units were successfully shipped according to the tracking number provided.

It is assumed that you will be integrating to the endpoint described in the API documentation:

Within the JSON file, you will see a section "Shipments" with information following that relates to the shipment. "Shipment" is just a container, and it can refer to a single order - which may then contain one or more packages.

The following are some examples of what the "Shipment" section of the JSON file could look like, depending on how many units are being shipped, and how many packages there are. In the case of a multi-unit order with only one tracking number, you would expect to see something similar to the "multiple units in a single package" example.

Examples:

1. Shipping a Single Unit (one tracking number)
2. Shipping Multiple Units in a Single Package (one tracking number)
3. Shipping Multiple Units in Multiple Packages (multiple tracking numbers)
4. Shipping Multiple Items in a Single Package (one tracking number)

Shipping a Single Unit (one tracking number)

The following is to ship a single unit.
"Shipments" : [{
       "Order" : {
                "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" /** PurchaseOrderId **/
        },
       "Packages" : [{
            "Lines" : [{
                       "Shipped" : {
                                    "Units" : 0,
                                    "Value" : 1.0 //***** the quantity shipped *****//
                                 },
                                 /** Use either the LineId or SKU **/ 
                       "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", /*** LineId ***/
                       "SKU": "SampleSKU"
                     }],
       "CarrierMethod" : {
              "Code" : "CarrierCode"
        },
        "TrackingNumber" : "SampleTrackingNumber"
        }]
}]

Shipping Multiple Units in a Single Package (one tracking number)

The following is to ship multiple units in a single package.

"Shipments" : [{
    "Order" : {
            "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" /** PurchaseOrderId **/
    },
    "Packages" : [{
          "Lines" : [{
                       "Shipped" : {
                            "Units" : 0,
                            "Value" : 2.0 //***** the quantity shipped *****//
                       },
                       /** Use either the LineId or SKU **/ 
                       "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", /*** LineId ***/
                       "SKU": "SampleSKU"
                    }],
         "CarrierMethod" : {
         "Code" : "CarrierCode"
     },
     "TrackingNumber" : "SampleTrackingNumber"
   }]
}]

Shipping Multiple Units in Multiple Packages (multiple tracking numbers)

The following is to shipment multi-units across multiple tracking numbers. 
Notice multiple "Packages".

"Shipments" : [{
     "Order" : {
              "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" /** PurchaseOrderId **/
      },
      "Packages" : [{
              "Lines" : [{
                      "Shipped" : {
                               "Units" : 0,
                               "Value" : 1.0 //***** the quantity shipped *****//
                      },
                      /** Use either the LineId or SKU **/ 
                      "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", /*** LineId ***/
                      "SKU": "SampleSKU"
                     }],
              "CarrierMethod" : {
                "Code" : "CarrierCode"
               },
              "TrackingNumber" : "SampleTrackingNumber"
       },
       {
               "Lines" : [{
                       "Shipped" : {
                                "Units" : 0,
                                "Value" : 1.0 //***** the quantity shipped *****//
                        },
                        /** Use either the LineId or SKU **/ 
                       "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", /*** LineId ***/
                       "SKU": "SampleSKU"
                        }],
                  "CarrierMethod" : {
                    "Code" : "CarrierCode"
                   },
                   "TrackingNumber" : "SampleTrackingNumber"
       }]
}]

Shipping Multiple Items in a Single Package (one tracking number)

The following ships multiple lines within a single package. Notice multiple "Lines".

"Shipments" : [{
      "Order" : {
             "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
       },
       "Packages" : [{
            "Lines" : [{
                  "Shipped" : {
                           "Units" : 0,
                           "Value" : 1.0 //***** the quantity shipped *****//
                  },
                  /** Use either the LineId or SKU **/ 
                  "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", /*** LineId ***/
                  "SKU": "SampleSKU"
       },
       {
                   "Shipped" : {
                            "Units" : 0,
                            "Value" : 1.0 //***** the quantity shipped *****//
                  },
                  /** Use either the LineId or SKU **/ 
                  "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", /*** LineId ***/
                  "SKU": "SampleSKU"
       }],
         "CarrierMethod" : {
              "Code" : "CarrierCode"
         },
         "TrackingNumber" : "SampleTrackingNumber"
      }]
}]