PUT /variant-parcels/{id}.json

PUT /variant-parcels/{id}.json

Path parameters

  • id integer(int64) Required

    Numeric ID of the instance

    Minimum value is 1.

application/json

Body Required

  • createdAt string(date-time)

    Created at

  • distanceUnit string | null Required

    Distance unit

    Values are in or cm. Default value is in.

  • id integer(int32)

    Id

  • packingDepth number | null Required

    Packing depth

    Default value is 2.4.

  • packingHeight number | null Required

    Packing height

    Default value is 13.3.

  • packingWidth number | null Required

    Packing width

    Default value is 11.5.

  • source string | null Required

    Source

    Values are import or internal. Default value is internal.

  • tags array[string] | null Required

    Tags

    Default value is [] (empty).

  • updatedAt string(date-time)

    Updated at

  • variantId integer(int32) Required

    Variant

  • weight number(float) | null Required

    Weight

    Default value is 0.

  • weightUnit string | null Required

    Weight unit

    Values are g, kg, oz, or lb. Default value is g.
PUT /variant-parcels/{id}.json 
curl \
 -X PUT http://api.example.com/v1/variant-parcels/{id}.json \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"createdAt":"2024-05-04T09:42:00+00:00","distanceUnit":"in","id":42,"packingDepth":2.4,"packingHeight":13.3,"packingWidth":11.5,"source":"internal","tags":[],"updatedAt":"2024-05-04T09:42:00+00:00","variantId":42,"weight":0,"weightUnit":"g"}'
Request example 
{
  "createdAt": "2024-05-04T09:42:00+00:00",
  "distanceUnit": "in",
  "id": 42,
  "packingDepth": 2.4,
  "packingHeight": 13.3,
  "packingWidth": 11.5,
  "source": "internal",
  "tags": [],
  "updatedAt": "2024-05-04T09:42:00+00:00",
  "variantId": 42,
  "weight": 0,
  "weightUnit": "g"
}