v1

latestOpenAPI 3.1.0MIT-LICENSE2026-07-24113190543.3 KB

Shipping Contacts

Create a shipping contacts

Create a shipping contacts for a customer.

post/customers/{id}/shipping_contacts

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

phonestring

Phone contact

receiverstring

Name of the person who will receive the order

between_streetsstring

The street names between which the order will be delivered.

parent_idstring

defaultboolean nullable

deletedboolean nullable

metadataobject

Metadata associated with the shipping contact

Example request

{
  "phone": "+525511223344",
  "receiver": "Marvin Fuller",
  "between_streets": "Ackerman Crescent",
  "address": {
    "street1": "Nuevo Leon 254",
    "street2": "Departamento 404",
    "postal_code": "06100",
    "city": "Ciudad de Mexico",
    "state": "Ciudad de Mexico",
    "country": "MX",
    "residential": true
  }
}

Response

successful operation