• France
status page
demonstrations
assistance
FAQContact support
Search
Categories
Tags
English
French
English
Homepage
Use cases
Create a payment
Create an installment payment
Create a multi-card (split) payment
Create a payment by Alias (Token)
Create a payment link
Create a recurring payment
Manage subscriptions
Manage your transactions (refund, cancel...)
Analyze your reports
API docs
Embedded Form
REST API
Hosted payment
Mobile payment
File exchange
Snippets
Payment methods
Plugins
Guides
Merchant Back Office
Functional guides

Transmitting shipping details

The merchant can transmit the buyer’s shipping details (e-mail address, title, phone number etc.).

This information can be found in the transaction details in the Merchant Back Office (Shipping tab).

Use the fields below according to your requirements. These fields will be returned with the response and will include the value transmitted in the form.
Field name Description Format Value
vads_ship_to_city City an..128 E.g.: Bordeaux
vads_ship_to_country Country code in compliance with the ISO 3166 standard (required for triggering one or more actions if the Shipping country control profile is enabled). a2 E.g.: FR
vads_ship_to_delivery_company_name Transporter's name providing the delivery.

Recommended field.

ans..255 E.g.: DHL
vads_ship_to_district District ans..127 E.g.: La Bastide
vads_ship_to_first_name First name ans..63 E.g.: Albert
vads_ship_to_last_name Last name ans..63 E.g.: Durant
vads_ship_to_legal_name Legal name an..100 E.g.: D. & Cie
vads_ship_to_phone_num Phone number ans..32 E.g.: 0460030288
vads_ship_to_state State / Region ans..127 E.g.: Nouvelle Aquitaine
vads_ship_to_status Allows to specify the type of the shipping address.

enum

PRIVATE : for shipping to a private individual

COMPANY : for shipping to a company

vads_ship_to_street Postal address
The following characters are accepted:
  • Alphabetical [aA-zZ]
  • Numeric [0-9]
  • Special " ' ` _ + . - ,
  • Space
ans..255 E.g.: Rue Sainte Catherine
vads_ship_to_street_number Street number ans..64 E.g.: 2
vads_ship_to_street2 Address line 2.
The following characters are accepted:
  • Alphabetical [aA-zZ]
  • Numeric [0-9]
  • Special " ' ` _ + . - ,
  • Space
ans..255
vads_ship_to_type Shipping mode. Recommended field.
Possible values:
  • 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 at an airport, a guard or a travel agency.
  • PACKAGE_DELIVERY_COMPANY for shipping by the transporter (Colissimo, UPS, etc.).
  • ETICKET for sending an electronic ticket, download.
enum E.g.: RECLAIM_IN_SHOP
vads_ship_to_speed Shipping delay. Recommended field.

Possible values:

  • STANDARD :
  • EXPRESS : - than 24 hours
  • PRIORITY : Click and Collect. This value will be used if vads_ship_to_type is sent to RECLAIM_IN_SHOP.
enum E.g.: EXPRESS
vads_ship_to_zip Zip code an..64 E.g.: 33000
© 2025 {'|'} All rights reserved to Sogecommerce
25.18-1.11