Sign in

v1

latestOpenAPI 3.0.3MIT-LICENSE2026-07-2469127278.1 KB
Shippings

Update Shipping

Updates an existing shipping line for an order. The shipping line identified by shipping_id belongs to the order identified by id. Only the fields provided in the request body are updated.

put/orders/{id}/shipping_lines/{shipping_id}

Path parameters

idstring required

Identifier of the resource

shipping_idstring required

identifier

Headers

Accept-Language'es' | 'en'

Use for knowing which language to use

X-Child-Company-Idstring

In the case of a holding company, the company id of the child company to which will process the request.

Request body

amountinteger required

Shipping amount in cents

carrierstring

Carrier name for the shipment

tracking_numberstring

Tracking number can be used to track the shipment

methodstring

Method of shipment

descriptionstring

Shipping line description

metadataobject

Hash where the user can send additional information for each 'shipping'.

Example request

{
  "amount": 100,
  "carrier": "FEDEX",
  "tracking_number": "TRACK123",
  "method": "Same day",
  "description": "Shipping line",
  "metadata": {
    "key": "value"
  }
}

Response

successful