Create a shipping location

HTTP Responses

• 200 - OK

  The request has succeeded.

  Show more Show less

  address object

  The address details of the shipping location.

  Show children Hide children

  city string

  The name of the city.

  companyName string

  The name of the company.

  country string

  The two-letter country code, in ISO 3166-1 alpha-2 format.

  postalCode string

  The postal code.

  stateOrProvince string

  The state or province as defined in ISO 3166-2. For example, ON for Ontario, Canada.

  Applicable for the following countries:

  • Australia
  • Brazil
  • Canada
  • India
  • Mexico
  • New Zealand
  • United States

  streetAddress string

  The name of the street, and the house or building number.

  streetAddress2 string

  Additional address details, if any.

  contact object

  The contact details for the shipping location.

  Show children Hide children

  email string

  The individual's email address.

  firstName string

  The individual's first name.

  infix string

  The infix in the individual's name, if any.

  lastName string

  The individual's last name.

  phoneNumber string

  The individual's phone number, specified as 10-14 digits with an optional + prefix.

  id string

  The unique identifier of the shipping location, for use as shippingLocationId when creating an order.

  name string

  The unique name of the shipping location.

• 400 - Bad Request

  A problem reading or understanding the request.

  Show more Show less

  detail string

  A human-readable explanation specific to this occurrence of the problem.

  errorCode string

  A code that identifies the problem type.

  instance string

  A unique URI that identifies the specific occurrence of the problem.

  invalidFields array [InvalidFieldWrapper]

  Detailed explanation of each validation error, when applicable.

  Show children Hide children

  InvalidField object

  Show children Hide children

  message string

  Description of the validation error.

  name string

  The field that has an invalid value.

  value string

  The invalid value.

  requestId string

  A unique reference for the request, essentially the same as pspReference.

  response object

  JSON response payload.

  Show children Hide children

  paths array [JSONPathWrapper]

  Show children Hide children

  JSONPath object

  Show children Hide children

  content array [string]

  rootPath object

  Show children Hide children

  content array [string]

  status integer

  The HTTP status code.

  title string

  A short, human-readable summary of the problem type.

  type string

  A URI that identifies the problem type, pointing to human-readable documentation on this problem type.

• 401 - Unauthorized

  Authentication required.

  Show more Show less

  detail string

  A human-readable explanation specific to this occurrence of the problem.

  errorCode string

  A code that identifies the problem type.

  instance string

  A unique URI that identifies the specific occurrence of the problem.

  invalidFields array [InvalidFieldWrapper]

  Detailed explanation of each validation error, when applicable.

  Show children Hide children

  InvalidField object

  Show children Hide children

  message string

  Description of the validation error.

  name string

  The field that has an invalid value.

  value string

  The invalid value.

  requestId string

  A unique reference for the request, essentially the same as pspReference.

  response object

  JSON response payload.

  Show children Hide children

  paths array [JSONPathWrapper]

  Show children Hide children

  JSONPath object

  Show children Hide children

  content array [string]

  rootPath object

  Show children Hide children

  content array [string]

  status integer

  The HTTP status code.

  title string

  A short, human-readable summary of the problem type.

  type string

  A URI that identifies the problem type, pointing to human-readable documentation on this problem type.

• 403 - Forbidden

  Insufficient permissions to process the request.

  Show more Show less

  detail string

  A human-readable explanation specific to this occurrence of the problem.

  errorCode string

  A code that identifies the problem type.

  instance string

  A unique URI that identifies the specific occurrence of the problem.

  invalidFields array [InvalidFieldWrapper]

  Detailed explanation of each validation error, when applicable.

  Show children Hide children

  InvalidField object

  Show children Hide children

  message string

  Description of the validation error.

  name string

  The field that has an invalid value.

  value string

  The invalid value.

  requestId string

  A unique reference for the request, essentially the same as pspReference.

  response object

  JSON response payload.

  Show children Hide children

  paths array [JSONPathWrapper]

  Show children Hide children

  JSONPath object

  Show children Hide children

  content array [string]

  rootPath object

  Show children Hide children

  content array [string]

  status integer

  The HTTP status code.

  title string

  A short, human-readable summary of the problem type.

  type string

  A URI that identifies the problem type, pointing to human-readable documentation on this problem type.

• 422 - Unprocessable Entity

  A request validation error.

  Show more Show less

  detail string

  A human-readable explanation specific to this occurrence of the problem.

  errorCode string

  A code that identifies the problem type.

  instance string

  A unique URI that identifies the specific occurrence of the problem.

  invalidFields array [InvalidFieldWrapper]

  Detailed explanation of each validation error, when applicable.

  Show children Hide children

  InvalidField object

  Show children Hide children

  message string

  Description of the validation error.

  name string

  The field that has an invalid value.

  value string

  The invalid value.

  requestId string

  A unique reference for the request, essentially the same as pspReference.

  response object

  JSON response payload.

  Show children Hide children

  paths array [JSONPathWrapper]

  Show children Hide children

  JSONPath object

  Show children Hide children

  content array [string]

  rootPath object

  Show children Hide children

  content array [string]

  status integer

  The HTTP status code.

  title string

  A short, human-readable summary of the problem type.

  type string

  A URI that identifies the problem type, pointing to human-readable documentation on this problem type.

• 500 - Internal Server Error

  The server could not process the request.

  Show more Show less

  detail string

  A human-readable explanation specific to this occurrence of the problem.

  errorCode string

  A code that identifies the problem type.

  instance string

  A unique URI that identifies the specific occurrence of the problem.

  invalidFields array [InvalidFieldWrapper]

  Detailed explanation of each validation error, when applicable.

  Show children Hide children

  InvalidField object

  Show children Hide children

  message string

  Description of the validation error.

  name string

  The field that has an invalid value.

  value string

  The invalid value.

  requestId string

  A unique reference for the request, essentially the same as pspReference.

  response object

  JSON response payload.

  Show children Hide children

  paths array [JSONPathWrapper]

  Show children Hide children

  JSONPath object

  Show children Hide children

  content array [string]

  rootPath object

  Show children Hide children

  content array [string]

  status integer

  The HTTP status code.

  title string

  A short, human-readable summary of the problem type.

  type string

  A URI that identifies the problem type, pointing to human-readable documentation on this problem type.