Add a Shipping Address

post

https://api-test.qualpay.com/platform/vault/customer/{customer_id}/shipping

Adds a shipping address to a profile in Customer Vault. The response includes a unique shipping_id, which can be used to manage the shipping_address.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

customer_id

string

required

The customer ID, returned as the customer_id value in an 'Add a Customer' response.

Body Params

Shipping Address

shipping_first_name

string

required

Format: Variable length, up to 32 AN
Description: Shipping first name.

shipping_last_name

string

required

Format: Variable length, up to 32 AN
Description: Shipping last name.

shipping_firm_name

string

Format: Variable length, up to 64 AN
Description: Business name of the shipping address, if applicable.

merchant_id

int64

Format: Variable length, up to 16 AN
Description: Identifies the merchant to whom this request applies. Optional field, applicable only if the request is sent on behalf of another merchant.
Conditional Requirement: Required if this request is on behalf of another merchant.

primary

boolean

Description: Set this field to true if this should be the primary address.
Default: false

shipping_addr1

string

Format: Variable length, up to 128 AN
Description: Shipping address line 1.

shipping_addr2

string

Format: Variable length, up to 128 AN
Description: Shipping address line 2.

shipping_city

string

Format: Variable length, up to 64 AN
Description: Shipping city.

shipping_state

string

Format: Fixed length, 3 AN
Description: Shipping state.

shipping_country

string

Format: Variable length, up to 128 AN
Description: Shipping country.

shipping_country_code

string

Format: Fixed length, 3 AN
Description: ISO numeric country code for the shipping address. Refer to Country Codes for a list of country codes.

shipping_zip

string

Format: Fixed length, 10 AN
Description: Shipping zip code.

shipping_zip4

string

Format: Fixed length, 4 N
Description: Shipping zip+4 code, if applicable.

Responses

200Success

400Request Validation Failed

500Internal Error