v1

latestOpenAPI 3.1.0MIT-LICENSE2026-07-24113190543.3 KB
Shippings

Create Shipping

Create new shipping for an existing orden

post/orders/{id}/shipping_lines

Path parameters

idstring required
Example:6307a60c41de27127515a575

Identifier of the resource

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

metadataobject

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

Example request

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

Response

successful