v1

latestOpenAPI 3.1.02026-08-06236494759.4 KB

Addresses

Add Address

Endpoint to create an Address.

post/business/v2/addresses

Headers

X-Soldo-Fingerprintstring required

Advanced authentication: SHA512SUM of the fingerprint values listed in the fingerprint order for this endpoint.

Example:{{fingerprint}}

X-Soldo-Fingerprint-Signaturestring required

Advanced authentication: Signature of the X-Soldo-Fingerprint.

Example:{{fingerprint_signature}}

Request body

recipientstring

The recipient of the addressee.

namestring required

The actual name of the Address.

line1string required

The primary street of the Address.

line2string

The optional secondary street.

country'ASC' | 'AND' | 'ARE' | 'AFG' | 'ATG' | 'AIA' | 'ALB' | 'ARM' | 'ANT' | 'AGO' | 'ATA' | 'ARG' | 'ASM' | 'AUT' | 'AUS' | 'ABW' | 'ALA' | 'AZE' | 'BIH' | 'BRB' | 'BGD' | 'BEL' | 'BFA' | 'BGR' | 'BHR' | 'BDI' | 'BEN' | 'BLM' | 'BMU' | 'BRN' | 'BOL' | 'BES' | 'BRA' | 'BHS' | 'BTN' | 'BUR' | 'BVT' | 'BWA' | 'BLR' | 'BLZ' | 'CAN' | 'CCK' | 'COD' | 'CAF' | 'COG' | 'CHE' | 'CIV' | 'COK' | 'CHL' | 'CMR' | 'CHN' | 'COL' | 'CPT' | 'CRI' | 'CSXX' | 'CUB' | 'CPV' | 'CUW' | 'CXR' | 'CYP' | 'CZE' | 'DEU' | 'DGA' | 'DJI' | 'DNK' | 'DMA' | 'DOM' | 'DZA' | 'ECU' | 'EST' | 'EGY' | 'ESH' | 'ERI' | 'ESP' | 'ETH' | 'FIN' | 'FJI' | 'FLK' | 'FSM' | 'FRO' | 'FRA' | 'FXX' | 'GAB' | 'GBR' | 'GRD' | 'GEO' | 'GUF' | 'GGY' | 'GHA' | 'GIB' | 'GRL' | 'GMB' | 'GIN' | 'GLP' | 'GNQ' | 'GRC' | 'SGS' | 'GTM' | 'GUM' | 'GNB' | 'GUY' | 'HKG' | 'HMD' | 'HND' | 'HRV' | 'HTI' | 'HUN' | 'IDN' | 'IRL' | 'ISR' | 'IMN' | 'IND' | 'IOT' | 'IRQ' | 'IRN' | 'ISL' | 'ITA' | 'JEY' | 'JAM' | 'JOR' | 'JPN' | 'KEN' | 'KGZ' | 'KHM' | 'KIR' | 'COM' | 'KNA' | 'PRK' | 'KOR' | 'KWT' | 'CYM' | 'KAZ' | 'LAO' | 'LBN' | 'LCA' | 'LIE' | 'LKA' | 'LBR' | 'LSO' | 'LTU' | 'LUX' | 'LVA' | 'LBY' | 'MAR' | 'MCO' | 'MDA' | 'MNE' | 'MAF' | 'MDG' | 'MHL' | 'MKD' | 'MLI' | 'MMR' | 'MNG' | 'MAC' | 'MNP' | 'MTQ' | 'MRT' | 'MSR' | 'MLT' | 'MUS' | 'MDV' | 'MWI' | 'MEX' | 'MYS' | 'MOZ' | 'NAM' | 'NCL' | 'NER' | 'NFK' | 'NGA' | 'NIC' | 'NLD' | 'NOR' | 'NPL' | 'NRU' | 'NTZ' | 'NIU' | 'NZL' | 'OMN' | 'PAN' | 'PER' | 'PYF' | 'PNG' | 'PHL' | 'PAK' | 'POL' | 'SPM' | 'PCN' | 'PRI' | 'PSE' | 'PRT' | 'PLW' | 'PRY' | 'QAT' | 'REU' | 'ROU' | 'ROM' | 'SRB' | 'RUS' | 'RWA' | 'SAU' | 'SLB' | 'SYC' | 'SDN' | 'SWE' | 'SGP' | 'SHN' | 'SVN' | 'SJM' | 'SVK' | 'SLE' | 'SMR' | 'SEN' | 'SOM' | 'SUR' | 'SSD' | 'STP' | 'SUN' | 'SLV' | 'SXM' | 'SYR' | 'SWZ' | 'TAA' | 'TCA' | 'TCD' | 'ATF' | 'TGO' | 'THA' | 'TJK' | 'TKL' | 'TLS' | 'TKM' | 'TUN' | 'TON' | 'TUR' | 'TTO' | 'TUV' | 'TWN' | 'TZA' | 'UKR' | 'UGA' | 'UMI' | 'USA' | 'URY' | 'UZB' | 'VAT' | 'VCT' | 'VEN' | 'VGB' | 'VIR' | 'VNM' | 'VUT' | 'WLF' | 'WSM' | 'XKX' | 'XXK' | 'QZZ' | 'YEM' | 'MYT' | 'YUCS' | 'ZAF' | 'ZMB' | 'ZRCD' | 'ZWE' required

countystring

The county code.

citystring required

The city name.

post_codestring required

The post code of the city.

delivery_phone_numberstring

The delivery phone including the country code.

default_shippingboolean

It is true if it's the default shipping address.

user_idstring

The ID of the User owner of the Address, required only when resource_type is USER.

Example request

{
  "recipient": "JohnSmith",
  "name": "Actual address of John",
  "line1": "Foo street 33",
  "line2": "Second floor",
  "county": "00000",
  "city": "London",
  "post_code": "00000",
  "delivery_phone_number": "+44123323232",
  "default_shipping": true,
  "user_id": "XMPL1234-000003",
  "cards_to_link": [
    [
      "7bf79328-a7ae-4222-aa54-091ff7f429a7",
      "2d65bd5e-3fdf-4002-b166-bde7fb8863fa"
    ]
  ]
}

Response

The returned resource is the single Address created.

idstring

The Address ID.

recipientstring

The recipient of the Address

namestring

The actual name of the Address.

line1string

The Address street.

line2string

An optional other street.

countrystring

The country of the Address.

countystring

The county of the Address.

citystring

The city of the Address.

post_codestring

The postal code of the Address.

delivery_phone_numberstring

Delivery phone number

default_shippingboolean

True if the Address is the default shipping address.

typestring

The type of the Address.

category'USER' | 'COMPANY'

user_idstring

The User ID, only if category of the Address is USER.

creation_timestring

The date and time when the Address was created.

last_updatestring

The date and time when the Address was last updated.

Example response

{
  "id": "7bf79328-a7ae-4222-aa54-091ff7f429a7",
  "recipient": "JohnSmith",
  "name": "Foo Street 75",
  "line1": "Bar Street 64",
  "line2": "Other street 31",
  "country": "GB",
  "county": "LD",
  "city": "London",
  "post_code": "00000",
  "delivery_phone_number": "+441234567890",
  "type": "SHIPPING",
  "creation_time": "2017-06-01T12:48:40Z",
  "last_update": "2017-06-01T12:48:40Z"
}