Update a package

How to update an existing package via API

To update an existing package, send a PATCH request to the /api/packages/:id endpoint, where id is the ID of the resource that you want to update.

Here below the list of all the possible arguments that you can pass with the request body.

Request

PATCH https://yourdomain.commercelayer.io/api/packages/:id

Arguments

Body Parameter	Type	Required
type	string	Required
id	string	Required
attributes.name	string	Optional
attributes.code	string	Optional
attributes.length	float	Optional
attributes.width	float	Optional
attributes.height	float	Optional
attributes.unit_of_length	string	Optional
attributes.reference	string	Optional
attributes.reference_origin	string	Optional
attributes.metadata	object	Optional
relationships.stock_location	object	Optional

Example

Request

The following request updates the package identified by the ID "xYZkjABcde":

curl -g -X PATCH \
  'https://yourdomain.commercelayer.io/api/packages/xYZkjABcde' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer your-access-token' \
  -H 'Content-Type: application/vnd.api+json' \
  -d '{
  "data": {
    "type": "packages",
    "id": "xYZkjABcde",
    "attributes": {
      "code": "YYYY 2000"
    },
    "relationships": {
      "stock_location": {
        "data": {
          "type": "stock_locations",
          "id": "ABCRtyUpBa"
        }
      }
    }
  }
}'

Response

On success, the API responds with a 200 OK status code, returning the updated resource object:

{
  "data": {
    "id": "xYZkjABcde",
    "type": "packages",
    "links": {
      "self": "https://yourdomain.commercelayer.io/api/packages/xYZkjABcde"
    },
    "attributes": {
      "name": "Large (60x40x30)",
      "code": "YYYY 2000",
      "length": 40.0,
      "width": 40.0,
      "height": 25.0,
      "unit_of_length": "gr",
      "created_at": "2018-01-01T12:00:00.000Z",
      "updated_at": "2018-01-01T12:00:00.000Z",
      "reference": "ANY-EXTERNAL-REFEFERNCE",
      "reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
      "metadata": {
        "foo": "bar"
      }
    },
    "relationships": {
      "stock_location": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/packages/xYZkjABcde/relationships/stock_location",
          "related": "https://yourdomain.commercelayer.io/api/packages/xYZkjABcde/stock_location"
        }
      },
      "parcels": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/packages/xYZkjABcde/relationships/parcels",
          "related": "https://yourdomain.commercelayer.io/api/packages/xYZkjABcde/parcels"
        }
      },
      "attachments": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/packages/xYZkjABcde/relationships/attachments",
          "related": "https://yourdomain.commercelayer.io/api/packages/xYZkjABcde/attachments"
        }
      },
      "versions": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/packages/xYZkjABcde/relationships/versions",
          "related": "https://yourdomain.commercelayer.io/api/packages/xYZkjABcde/versions"
        }
      }
    },
    "meta": {
      "mode": "test",
      "organization_id": "xRRkjDFafe",
      "trace_id": "69abaa3545913c78132e5578bd26208d44aa9043647d78698fd0021f3958cd74"
    }
  }
}