Customers

Create customer address

post/v3/customers/{id}/address

Request

Base URL
https://integrators.prod.api.tabsplatform.com
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/tabsplatform/apis/tabs-external-api/docs/v3/customers/:id/address/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

Request body

line1string required

Primary street address

line2string

Secondary address line (apt, suite, etc)

postalCodestring required

Postal/ZIP code

citystring required

City name

statestring required

State/province name

countrystring

Country Code

addresseestring

Name of recipient/addressee

isDefaultBillingboolean required

Is default billing address

isDefaultShippingboolean required

Is default shipping address

Example request

{
  "line1": "123 Main St",
  "line2": "Apt 1",
  "postalCode": "10001",
  "city": "New York",
  "state": "NY",
  "country": "US",
  "addressee": "John Doe",
  "isDefaultBilling": true,
  "isDefaultShipping": true
}

Response

Created address

Changes

No recorded changes to this operation across all 1 revision of this API.