Skip to content

Customer addresses

Open .md

API reference Customers Customers

A customer's billing and shipping addresses. The first of each role is primary. An address already used on a document is copied, not changed, when you edit it.

7 operations

  • POSTAdd an address to a customer/v1/api/store/{team_slug}/customer/{hash_id}/addressAdds a billing or shipping address and returns it.
  • GETList a customer's addresses/v1/api/store/{team_slug}/customer/{hash_id}/addressLists the customer's current billing and shipping addresses: the ones you can pick for new documents or edit.
  • GETGet a customer address/v1/api/store/{team_slug}/customer/{hash_id}/address/{id}Returns one of the customer's addresses, deleted and replaced ones included, with used_by_active_profile.
  • PUTUpdate a customer address/v1/api/store/{team_slug}/customer/{hash_id}/address/{id}Saves changes to an address.
  • PATCHSet the primary address/v1/api/store/{team_slug}/customer/{hash_id}/address/{id}/primaryMakes this address the customer's primary address of its role (billing or shipping); the previous one stops being primary.
  • DELETEDelete a customer address/v1/api/store/{team_slug}/customer/{hash_id}/address/{id}Deletes a current address.
  • PATCHRestore a deleted customer address/v1/api/store/{team_slug}/customer/{hash_id}/address/{id}/restoreBrings back a deleted address.