v1

latestOpenAPI 3.1.02026-07-241120379.1 KB

Create address

This endpoint is used to create a customer address. Rate limit - 1 / 5s

post/2023-10/address

Request body

customerShopifyIdinteger required

Unique identifier assigned to a customer within the Shopify platform.

firstNamestring
lastNamestring required
companystring
phonestring
address1string required
address2string
citystring
zipstring
provinceCodestring
countryCodestring required

Response

200

successboolean
messagestring
{"stackTrail":"paths:/2023-10/address:post:responses:200:content:application/json:schema:properties:data","oasType":"schema","type":"unknown"}
codestring
{"stackTrail":"paths:/2023-10/address:post:responses:200:content:application/json:schema:properties:pageInfo","oasType":"schema","type":"unknown"}

Example response

{
  "success": true,
  "message": "Address created successfully",
  "code": "SUCCESS"
}