COconekta
Shippings

Update Shipping

Changed on

Update existing shipping for an existing orden

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

Request

Path parameters

idstring required
Example:6307a60c41de27127515a575

Identifier of the resource

shipping_idstring required
Example:ship_lin_2tQ974hSHcsdeSZHG

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

metadataobject

Hash where the user can send additional information for each 'shipping'. Values must be scalar (string of at most 249 characters, integer, number or boolean); nested objects and arrays are not supported.

Example request

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

Response

successful

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'. Values must be scalar (string of at most 249 characters, integer, number or boolean); nested objects and arrays are not supported.

idstring
objectstring
parent_idstring

Example response

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

Changes

  • 52f4c0dd8a1bRevision changes
    • breaking

      the request property's minLength was increased from 0 to 3

    • breaking

      the request property's minLength was increased from 0 to 3

    • breaking

      the request property's minLength was increased from 0 to 3

    • warning

      the request property's maxLength was set to 249

    • warning

      the request property's maxLength was set to 249

    • warning

      the request property's maxLength was set to 249