Backend API: Retrieve a shipment

Arguments

idobjectIdrequired

The id of the shipment to retrieve.

expandstring

Expanding link fields and child collections is performed using the expand argument.

For example, expand=account would return a related customer account if one exists.

When the field represents a collection, you can specify the query limit.

For example, expand=variants:10 would return up to 10 records of the variants collection.

See expanding for more details.

fieldsstring

Return only the specified fields in the result. For example fields=name,slug would return only the fields name and slug in the response. Supports nested object and array fields using dot-notation, for example, items.product_id. The category id is always returned.

includestring

Include one or more arbitrary queries in the response, possibly related to the main query.

See including for more details.

GET/shipments/:id

const { swell } = require('swell-node');
swell.init('store-id', 'secret-key');

await swell.get('/shipments/{id}', {
  id: '60f199509111e70000000094'
});

Response

{
  "id": "60f199509111e70000000094",
  "items": [
    {
      "id": "5ca537326a0ec32a521139dd",
      "order_item_id": null,
      "product_id": "5cad15bc9b14d1990724663b",
      "quantity": 2
    }
  ],
  "order_id": "60f199509111e70000000095",
  "date_created": "2021-07-16T14:36:00.413Z",
  "date_updated": "2021-07-16T14:36:00.413Z",
  "destination": {
    "name": "Jon Snow",
    "address1": "1 Main Street",
    "city": "Brooklyn",
    "state": "NY",
    "zip": 11201,
    "country": "US",
    "phone": "(555) 555-5555"
  },
  "service": "fedex_ground",
  "tracking_code": "T192000000XYZ"
}