COconekta
Shipping Contacts

Create a shipping contacts

Changed on

Create a shipping contacts for a customer.

post/customers/{id}/shipping_contacts

Request

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. Must contain at least two consecutive ASCII letters.

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

phonestring
receiverstring
between_streetsstring nullable
parent_idstring
defaultboolean
idstring
created_atinteger
metadataobject

Metadata associated with the shipping contact

objectstring
deletedboolean

Example response

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

Changes

  • 52f4c0dd8a1bRevision changes
    • breaking

      added subschema #1: shipping_contact_address to the request property allOf list

    • breaking

      added the pattern [A-Za-z]{2} to the request property

    • warning

      the request property's maxLength was set to 249

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /