Update Order

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

order

object

required

The order fields new values.

Show child attributes

order.status

enum<string>

The new status of the order.

Available options:

NEW,

CONFIRMED,

READY,

CANCELLED

Example:

"NEW"

order.recipient

object

Details of the recipient of the order.

Show child attributes

order.recipient.firstName

string

required

The first name of the order recipient.

Example:

"Valentina"

order.recipient.lastName

string

required

The last name of the order recipient.

Example:

"Rodríguez López"

order.recipient.email

string

required

The email address of the recipient.

Example:

"[email protected]"

order.recipient.phoneNumber

string

required

The phone number of the recipient.

Example:

"+573193210329"

order.recipient.address

object

required

The address details.

Show child attributes

order.recipient.address.addressLines

string[]

required

Two lines detailing the specific street address, including street name, building number, apartment or suite number, and any other relevant details.

Example:

["Calle 123", "Apto 2"]

order.recipient.address.organization

string | null

The name of the organization associated with this address, if applicable.

order.recipient.location

string

required

The resource name of the destination location.

Maximum string length: 96

Example:

"locations/CO-11001000"

order.recipient.documentType

enum<string> | null

The type of document identifying the recipient.

Available options:

CC,

CE,

NI,

TI

Example:

"CC"

order.recipient.document

string | null

The document number of the recipient.

Example:

"1040777098"

order.contentDescription

string

A very short description of the package content.

Required string length: 3 - 128

Example:

"Shoes"

order.notes

string

A detailed description of the contents of this package and additional information.

Required string length: 3 - 2048

Example:

"1 Pair of Reebok Nano, Size 8, Color Black"

order.sellingPriceCents

number

The order selling price, just for reporting purposes.

Example:

1430000

order.cashOnDeliveryRequestCents

number

The amount to be collected on delivery in cents.

Required range: x >= 0

Example:

8900000

Example:

{
  "status": "CONFIRMED",
  "sellingPriceCents": 1490000
}

updateMask

enum<string>[]

required

The list of fields to be updated.

Minimum array length: 1

Available options:

status,

recipient,

sellingPriceCents,

cashOnDeliveryRequestCents,

contentDescription,

notes

Example:

["status", "sellingPriceCents"]

Response

200 - application/json

Successfully updated a order.

name

string

required

The unique identifier of the order.

Example:

"orders/669a8cba6af86466a42de2fe"

createTime

string

required

The timestamp when the order was created.

Example:

"2024-07-17T21:32:52.478Z"

updateTime

string

required

The timestamp when the order was last updated.

Example:

"2024-07-17T21:32:52.478Z"

status

enum<string>

required

The current status of the order.

Available options:

NEW,

CONFIRMED,

READY,

IN_PROGRESS,

CANCELLED,

DELIVERED,

RETURN

Example:

"NEW"

recipient

object

required

Details of the recipient of the order.

Show child attributes

recipient.firstName

string

required

The first name of the order recipient.

Example:

"Valentina"

recipient.lastName

string

required

The last name of the order recipient.

Example:

"Rodríguez López"

recipient.email

string

required

The email address of the recipient.

Example:

"[email protected]"

recipient.phoneNumber

string

required

The phone number of the recipient.

Example:

"+573193210329"

recipient.address

object

required

The address details.

Show child attributes

recipient.address.regionCode

string

required

The ISO 3166-1 alpha-2 region code representing the country or territory.

Example:

"CO"

recipient.address.administrativeArea

string

required

The primary administrative division, such as a state or province, within the region.

Example:

"Antioquia"

recipient.address.locality

string

required

The specific city, town, or municipality.

Example:

"Abejorral"

recipient.address.addressLines

string[]

required

Two lines detailing the specific street address, including street name, building number, apartment or suite number, and any other relevant details.

Example:

["Calle 123", "Apto 2"]

recipient.address.organization

string

required

The name of the organization associated with this address, if applicable.

Example:

"Happeett"

recipient.location

string

required

The resource name of the destination location.

Maximum string length: 96

Example:

"locations/CO-11001000"

recipient.documentType

enum<string> | null

The type of document identifying the recipient.

Available options:

CC,

CE,

NI,

TI

Example:

"CC"

recipient.document

string | null

The document number of the recipient.

Example:

"1040777098"

contentDescription

string

required

A description of the package content.

Required string length: 3 - 128

Example:

"Shoes"

notes

string

required

A detailed description of the contents of this package and additional information.

Required string length: 3 - 2048

Example:

"1 Pair of Reebok Nano, Size 8, Color Black"

sellingPriceCents

number

required

The order selling price, just for reporting purposes.

Example:

1430000

cashOnDeliveryRequestCents

number

required

The amount to be collected on delivery in cents.

Required range: x >= 0

Example:

8900000

customerReliability

enum<string>

required

The reliability of the customer.

Available options:

RELIABLE,

MODERATE,

UNRELIABLE,

NO_ORDERS

Example:

"RELIABLE"

customerBehavior

object

required

Show child attributes

customerBehavior.totalShipments

number

required

The total number of shipments made by the customer.

Example:

10

customerBehavior.deliveredShipments

number

required

The total number of shipments delivered by the customer.

Example:

8

customerBehavior.returnedShipments

number

required

The total number of shipments returned by the customer.

Example:

2

customerBehavior.reliability

enum<string>

required

The reliability of the customer.

Available options:

RELIABLE,

MODERATE,

UNRELIABLE,

NO_ORDERS

Example:

"RELIABLE"

shipment

string

The unique identifier for the associated shipment.

Example:

"shipments/669986bb4ae1239d5a92cdff"

referenceId

string

The ID of the order in the external system that created it, like Shopify order name.

Example:

"4012"

referenceGid

string

The global identifier of the order in the external system, like Shopify order GID.

Example:

"93240958723"

referenceUrl

string<uri>

The URL to the order in the external system, like Shopify order URL.

Example:

"https://mystore.com/order/1234567890"

paymentMethods

string[]

Payment methods used for this order.

Example:

["cash_on_delivery", "credit_card"]

Guías

Shipping

Authorizations

Body

Response