Create

Creates address information for an individual customer.

post/addresses/create/

Request

  • Base URL
    https://restapi.ordergroove.com
  • Auth
    • none
    • or API key in header x-api-key

Request body

customerstring required

Customer ID

address_typestring required

Customer address type ('billing_address' or 'shipping_address')

first_namestring required

Customer first name

last_namestring required

Customer last name

labelstring
company_namestring

Customer company name

addressstring required

Customer primary address

address2string

Additional customer address

citystring required

Customer city name

state_province_codestring required

Customer state or province

zip_postal_codestring required

Customer postal code

country_codestring required

Customer country code

phonestring required

Customer phone number

faxstring

Customer fax number

token_idstring

External merchant reference

Response

200

customerstring
public_idstring
labelunknown
first_namestring
last_namestring
company_nameunknown
addressstring
address2unknown
citystring
state_province_codestring
zip_postal_codestring
phonestring
faxunknown
country_codestring
liveboolean
createdstring
token_idunknown
store_public_idunknown

Example response

{
  "customer": "00026001",
  "public_id": "c4cd7f86ccc411e8ada3bc764e101db1",
  "first_name": "Nathan",
  "last_name": "Torres",
  "address": "75 Broad St Fl 23",
  "city": "New York",
  "state_province_code": "NY",
  "zip_postal_code": "10004-2487",
  "phone": "3154055372",
  "country_code": "US",
  "live": true,
  "created": "2018-10-10 14:43:32"
}

Changes

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