API reference
Addresses
Customer API: GET /addresses, POST /addresses, PATCH /addresses/{id}, …
Shipping and billing addresses in the customer's address book. Each kind has one default.
Response 200
addressesobject[]requiredaddresses[].idstringrequiredaddresses[].kind"SHIPPING" | "BILLING"requiredaddresses[].countryCodestringrequiredaddresses[].recipientNamestringrequiredaddresses[].phonestring | nullrequiredaddresses[].addressLine1stringrequiredaddresses[].addressLine2string | nullrequiredaddresses[].localitystring | nullrequiredaddresses[].regionstring | nullrequiredaddresses[].postalCodestring | nullrequiredaddresses[].isDefaultbooleanrequiredThe default address of its kind.
addresses[].createdAtstringrequired
curl -X GET "https://{site}/api/v1/customer/addresses" \
-H "Authorization: Bearer $KANORIO_CUSTOMER_TOKEN"Fields and required parts follow the country's postal format (the same registry the checkout and form address fields use). An address identical to an existing one of the same kind returns that one instead of creating a duplicate. The first address of a kind becomes the default.
Request body
kind"SHIPPING" | "BILLING"addressobjectrequiredaddress.countryCodestringrequiredISO 3166-1 alpha-2; decides which parts are required.
address.recipientNamestringrequiredaddress.phonestring | nullE.164, or a national number of the address country.
address.addressLine1stringrequiredaddress.addressLine2string | nulladdress.localitystring | nullCity / district.
address.regionstring | nullState / province / prefecture.
address.postalCodestring | nullsetDefaultboolean
Response 200
addressobjectrequiredaddress.idstringrequiredaddress.kind"SHIPPING" | "BILLING"requiredaddress.countryCodestringrequiredaddress.recipientNamestringrequiredaddress.phonestring | nullrequiredaddress.addressLine1stringrequiredaddress.addressLine2string | nullrequiredaddress.localitystring | nullrequiredaddress.regionstring | nullrequiredaddress.postalCodestring | nullrequiredaddress.isDefaultbooleanrequiredThe default address of its kind.
address.createdAtstringrequiredcreatedboolean
Errors
ADDRESS_INVALID400ADDRESS_LIMIT_REACHED403
curl -X POST "https://{site}/api/v1/customer/addresses" \
-H "Authorization: Bearer $KANORIO_CUSTOMER_TOKEN" \
-H "Content-Type: application/json" \
-d '{}'The whole address is replaced. When the result equals another saved address of the same kind, the two are merged into that one.
Parameters
idstring · pathrequired
Request body
addressobjectrequiredaddress.countryCodestringrequiredISO 3166-1 alpha-2; decides which parts are required.
address.recipientNamestringrequiredaddress.phonestring | nullE.164, or a national number of the address country.
address.addressLine1stringrequiredaddress.addressLine2string | nulladdress.localitystring | nullCity / district.
address.regionstring | nullState / province / prefecture.
address.postalCodestring | null
Response 200
addressobjectrequiredaddress.idstringrequiredaddress.kind"SHIPPING" | "BILLING"requiredaddress.countryCodestringrequiredaddress.recipientNamestringrequiredaddress.phonestring | nullrequiredaddress.addressLine1stringrequiredaddress.addressLine2string | nullrequiredaddress.localitystring | nullrequiredaddress.regionstring | nullrequiredaddress.postalCodestring | nullrequiredaddress.isDefaultbooleanrequiredThe default address of its kind.
address.createdAtstringrequiredcreatedboolean
Errors
NOT_FOUND404ADDRESS_INVALID400
curl -X PATCH "https://{site}/api/v1/customer/addresses/{id}" \
-H "Authorization: Bearer $KANORIO_CUSTOMER_TOKEN" \
-H "Content-Type: application/json" \
-d '{}'When the default of a kind is removed, the most recently added address of that kind becomes the default.
Parameters
idstring · pathrequired
Errors
NOT_FOUND404
curl -X DELETE "https://{site}/api/v1/customer/addresses/{id}" \
-H "Authorization: Bearer $KANORIO_CUSTOMER_TOKEN"Parameters
idstring · pathrequired
Response 200
addressobjectrequiredaddress.idstringrequiredaddress.kind"SHIPPING" | "BILLING"requiredaddress.countryCodestringrequiredaddress.recipientNamestringrequiredaddress.phonestring | nullrequiredaddress.addressLine1stringrequiredaddress.addressLine2string | nullrequiredaddress.localitystring | nullrequiredaddress.regionstring | nullrequiredaddress.postalCodestring | nullrequiredaddress.isDefaultbooleanrequiredThe default address of its kind.
address.createdAtstringrequiredcreatedboolean
Errors
NOT_FOUND404
curl -X POST "https://{site}/api/v1/customer/addresses/{id}/default" \
-H "Authorization: Bearer $KANORIO_CUSTOMER_TOKEN" \
-H "Content-Type: application/json" \
-d '{}'