Objeto shippingDetails

Atributo Formato
type

Tipo de comprador.

Os valores possíveis são:

  • PRIVATE para uma pessoa física.
  • COMPANY para uma pessoa jurídica.
string (enum)
firstName

Sobrenome do comprador.

string ans..128
lastName

Nome do comprador.

string ans..128
phoneNumber

Número de telefone do comprador.

string ans..32
streetNumber

Número de rua para a entrega.

Observação: se este atributo está presente na solicitação, não pode ser enviado vazio.

string an..5
address

Endereço de entrega.

string ans..255
address2

Complemento de endereço de entrega.

string ans..255
district

Bairro de entrega.

string ans..127
zipCode

CEP de entrega.

string ans..64
city

Cidade de entrega.

string ans..128
state

UF / Região de entrega.

string ans..128
country

País de entrega.

string - a2
deliveryCompanyName

Informações sobre a transportadora.

string ans..128
shippingSpeed

Modo de entrega selecionado.

Os valores possíveis são:

  • STANDARD para uma entrega padrão.
  • EXPRESS para uma entrega express.
string (enum)
shippingMethod

Método de entrega utilizado.

Os valores possíveis são:

  • RECLAIM_IN_SHOP para retirar a mercadoria na loja.
  • RELAY_POINT para a utilização de uma rede de pontos de entrega terceirizada (Kiala, Alveol, etc).
  • RECLAIM_IN_STATION para retirar em um aeroporto, em uma agência de viagens ou em outros.
  • PACKAGE_DELIVERY_COMPANY para a entrega por transportadora (Colissimo, UPS, etc).
  • ETICKET para emitir uma passagem eletrônica, baixar.
string (enum)
legalName

Razão social da empresa.

string ans..128
identityCode

Possibilita identificar de maneira única cada cidadão dentro de um país.

Por exemplo, no Brasil, ClearSale impõe que este campo seja informado com o CPF/ CNPJ (formato numérico, de 11 até 20 dígitos).

string ans..255