COcommercelayer
shipments

Update a shipment

Changed on

Update a shipment

patch/shipments/{shipmentId}

Request

  • Base URL
    https://{your_organization_slug}.commercelayer.io/api
  • URL
    https://{your_organization_slug}.commercelayer.io/api/shipments/{shipmentId}
  • Auth
    HTTP bearer

Path parameters

shipmentIdstring required

The resource's id

Request body

Example request

{
  "data": {
    "id": "XAyRWNUzyN",
    "attributes": {
      "number": "#1234/S/001",
      "_upcoming": true,
      "_cancel": true,
      "_on_hold": true,
      "_picking": true,
      "_packing": true,
      "_ready_to_ship": true,
      "_ship": true,
      "_deliver": true,
      "_reserve_stock": true,
      "_release_stock": true,
      "_decrement_stock": true,
      "_get_rates": true,
      "selected_rate_id": "rate_f89e4663c3ed47ee94d37763f6d21d54",
      "_purchase": true,
      "reference": "ANY-EXTERNAL-REFEFERNCE",
      "reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
      "metadata": {
        "foo": "bar"
      }
    },
    "relationships": {
      "shipping_category": {
        "data": {
          "id": "XAyRWNUzyN"
        }
      },
      "inventory_stock_location": {
        "data": {
          "id": "XAyRWNUzyN"
        }
      },
      "shipping_address": {
        "data": {
          "id": "XAyRWNUzyN"
        }
      },
      "shipping_method": {
        "data": {
          "id": "XAyRWNUzyN"
        }
      },
      "tags": {
        "data": {
          "id": "XAyRWNUzyN"
        }
      }
    }
  }
}

Response

The updated shipment object

Changes

  • 7626ac743941Revision changes
    • info

      added the optional property // to the response with the status

  • 859097ed3fe6Revision changes
    • breaking

      added the new required request property ///

    • breaking

      request property / was restricted to a list of enum values

    • warning

      removed the request property ///

    • warning

      removed the request property ///

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      the request property // became nullable

    • info

      the request property // became nullable

    • info

      the request property // became nullable

    • info

      the request property // became nullable

    • info

      the request property default value shipments was removed

    • info

      added the new shipments enum value to the request property /

    • info

      added the media type application/vnd.api+json for the response with the status