Skip to content
Coritan Docs

Organization API: Customers: Store

The 7 Organization API operations for store.

View as Markdown

Part of Customers.

Operations

Section titled Operations
Method Path Summary
GET /api/v1/orgs/{org_slug}/store/customers/me Get me
PATCH /api/v1/orgs/{org_slug}/store/customers/me Name, phone, marketing consent (the shopper alone turns it on) and VAT id
GET /api/v1/orgs/{org_slug}/store/customers/me/addresses List my addresses
POST /api/v1/orgs/{org_slug}/store/customers/me/addresses Add my address
PATCH /api/v1/orgs/{org_slug}/store/customers/me/addresses/{address_id} Update my address
DELETE /api/v1/orgs/{org_slug}/store/customers/me/addresses/{address_id} Delete my address
GET /api/v1/orgs/{org_slug}/store/customers/me/orders The shopper's orders in the key's mode, newest first

Get me

Section titled Get me

GET /api/v1/orgs/{org_slug}/store/customers/me

Parameters

Section titled Parameters
Name In Type Required
org_slug path string yes

Responses

Section titled Responses
Status Meaning
200 Success.
422 The request is not valid. detail lists each problem.

Name, phone, marketing consent (the shopper alone turns it on) and VAT id

Section titled Name, phone, marketing consent (the shopper alone turns it on) and VAT id

PATCH /api/v1/orgs/{org_slug}/store/customers/me

Name, phone, marketing consent (the shopper alone turns it on) and VAT id.

Parameters

Section titled Parameters
Name In Type Required
org_slug path string yes

Request body

Section titled Request body

application/json (required)

Field Type Required
first_name string or null no
last_name string or null no
phone string or null no
accepts_marketing boolean or null no
vat_id string or null no

Responses

Section titled Responses
Status Meaning
200 Success.
422 The request is not valid. detail lists each problem.

List my addresses

Section titled List my addresses

GET /api/v1/orgs/{org_slug}/store/customers/me/addresses

Parameters

Section titled Parameters
Name In Type Required
org_slug path string yes

Responses

Section titled Responses
Status Meaning
200 Success.
422 The request is not valid. detail lists each problem.

Add my address

Section titled Add my address

POST /api/v1/orgs/{org_slug}/store/customers/me/addresses

An address needs address_1, city and country_code; the first one saved is the default for shipping and billing.

Parameters

Section titled Parameters
Name In Type Required
org_slug path string yes

Request body

Section titled Request body

application/json (required)

Field Type Required
first_name string or null no
last_name string or null no
company string or null no
address_1 string or null no
address_2 string or null no
city string or null no
province string or null no
postal_code string or null no
country_code string or null no
phone string or null no
is_default_shipping boolean or null no
is_default_billing boolean or null no
metadata object or null no

Responses

Section titled Responses
Status Meaning
201 Success.
422 The request is not valid. detail lists each problem.

Update my address

Section titled Update my address

PATCH /api/v1/orgs/{org_slug}/store/customers/me/addresses/{address_id}

Parameters

Section titled Parameters
Name In Type Required
address_id path integer yes
org_slug path string yes

Request body

Section titled Request body

application/json (required)

Field Type Required
first_name string or null no
last_name string or null no
company string or null no
address_1 string or null no
address_2 string or null no
city string or null no
province string or null no
postal_code string or null no
country_code string or null no
phone string or null no
is_default_shipping boolean or null no
is_default_billing boolean or null no
metadata object or null no

Responses

Section titled Responses
Status Meaning
200 Success.
422 The request is not valid. detail lists each problem.

Delete my address

Section titled Delete my address

DELETE /api/v1/orgs/{org_slug}/store/customers/me/addresses/{address_id}

Parameters

Section titled Parameters
Name In Type Required
address_id path integer yes
org_slug path string yes

Responses

Section titled Responses
Status Meaning
200 Success.
422 The request is not valid. detail lists each problem.

The shopper's orders in the key's mode, newest first

Section titled The shopper's orders in the key's mode, newest first

GET /api/v1/orgs/{org_slug}/store/customers/me/orders

The shopper's orders in the key's mode, newest first.

Parameters

Section titled Parameters
Name In Type Required Description
org_slug path string yes
limit query integer no Default: 20.
offset query integer no Default: 0.

Responses

Section titled Responses
Status Meaning
200 Success.
422 The request is not valid. detail lists each problem.