shippingDetails object

shippingDetails has the following attributes:

Table 1. shippingDetails object
shippingDetails
Attribute Required Format
type

Buyer type.

The possible values are:

  • PRIVATE for a private client.
  • COMPANY for a company.
   string (enum)
firstName

Buyer's last name.

   string ans..128
lastName

Buyer's first name.

   string ans..128
phoneNumber

Buyer's phone number.

   string ans..32
streetNumber

Shipping street number.

Note: if this attribute is present in the query, it cannot be submitted empty.

  string an..5
address

Shipping address.

   string ans..255
address2

Additional details for the shipping address.

   string ans..255
district

Shipping district.

   string ans..127
zipCode

Shipping postal code.

   string ans..64
city

Shipping city.

   string ans..128
state

Shipping State/Region.

   string ans..128
country

Shipping country.

   string - a2
deliveryCompanyName

Information about the transporter.

   string ans..128
shippingSpeed

Chosen shipping mode.

The possible values are:

  • STANDARD for standard shipping.
  • EXPRESS for express shipping.
   string (enum)
shippingMethod

Used shipping method.

The possible values are:

  • RECLAIM_IN_SHOP for picking up the item at the shop.
  • RELAY_POINT for using a third-party pick-up network (Kiala, Alveol, etc).
  • RECLAIM_IN_STATION for picking up the item in an airport, from a guard or a travel agency.
  • PACKAGE_DELIVERY_COMPANY for shipping by the transporter (Colissimo, UPS, etc.).
  • ETICKET for sending an electronic ticket, download.
   string (enum)
legalName

Company name.

   string ans..128
identityCode

Allows each citizen to identify him/herself with a unique ID within a country.

For example, in Brazil, ClearSale requires this field to be populated with the CPF/ CPNJ (in numeric format, between 11 and 20 digits long).

   string ans..255