Data Formats used in the requests

Addresses

The addresses will be used to identify where to deliver the products. They are structured as follow:

• postal_code
  • Type: String
  • Required: Yes
  • Description: postal code
• street_type
  • Type: String
  • Required: No
  • Description: street type (street, place, etc.)
• street_name
  • Type: String
  • Required: Yes
  • Description: street name.
• street_number
  • Type: Integer
  • Required: No
  • Description: street number
• floor
  • Type: String
  • Required: No
  • Description: floor
• door
  • Type: String
  • Required: No
  • Description: door
• city
  • Type: String
  • Required: Yes
  • Description: city name
• province
  • Type: String
  • Required: No
  • Description: province
• country_code
  • Type: CountryCode
  • Required: Yes
  • Description: 2 letter ISO3166 code of the country.

Shoppers

Shopper information is used to identify the shopper and provides contact information.

• name
  • Type: String
  • Required: Yes
  • Description: name
• surname
  • Type: String
  • Required: Yes
  • Description: surnames.
• email
  • Type: String
  • Required: Yes
  • Description: email
• phone
  • Type: String
  • Required: No
  • Description: phone number

Products

Products are identified by their type, their availability, price and size.

• name
  • Type: String
  • Required: Yes
  • Description: product name
• reference
  • Type: String
  • Required: Yes
  • Description: product reference in eCommerce.
• quantity
  • Type: Integer
  • Required: Yes
  • Description: number of products of this type in the basket
• Size
  • Type: SizeType
  • Required: No
  • Description: product size
• weight_kg
  • Type: Float
  • Required: No
  • Description: peso de un producto en kg - origin_information
• price
  • Type: Price (float with 2 decimal digits maximum)
  • Required: No
  • Description: price of one product.
• currency_code
  • Type: Currency Code
  • Required: No
  • Description: currency code as defined in ISO4217. For now, we will only accept transactions in euros ("EUR")
• availability_date
  • Type: Date
  • Required: No
  • Description: date as defined in ISO8601. Date when the product is going to be available for pickup
• stock
  • Type: integer
  • Required: No
  • Description: number of items of this product that are still available

Size

PProduct Size is defined as follow:

• height_cm
  • Type: Integer
  • Required: Yes
  • Description: height in cm
• width_cm
  • Type: Integer
  • Required: Yes
  • Description: width in cm
• depth_cm
  • Type: Integer
  • Required: Yes
  • Description: depth in cm