Organization API: Commerce Store API: Store

Part of Commerce Store API.

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

POST /api/v1/orgs/{org_slug}/store/affiliates/hits

One click on a referral link today (UTC); 204 whether or not the code counted.

application/json (required)

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

The shopper's own affiliate record and the program's terms.

POST /api/v1/orgs/{org_slug}/store/affiliates/me

Make the shopper an affiliate with the code they ask for, or one made up.

application/json

POST /api/v1/orgs/{org_slug}/store/affiliates/me/claims

Claim the next reward the shopper has earned.

application/json (required)

GET /api/v1/orgs/{org_slug}/store/affiliates/program

The program's public terms, for the storefront's cookie and its signup page.

GET /api/v1/orgs/{org_slug}/store/affiliates/validate

{valid}: whether the code belongs to an active affiliate while the program is on.

POST /api/v1/orgs/{org_slug}/store/carts

A cart in the key's mode and sales channel, in a region and its currency.

application/json (required)

GET /api/v1/orgs/{org_slug}/store/carts/recover

The cart an abandoned cart or failed payment email links to, while it is open.

GET /api/v1/orgs/{org_slug}/store/carts/{cart_id}

PATCH /api/v1/orgs/{org_slug}/store/carts/{cart_id}

Email, addresses, region or country (re-prices every line), note, locale, metadata.

application/json (required)

POST /api/v1/orgs/{org_slug}/store/carts/{cart_id}/complete

Place the cart's order: {"order", "access_token"}. The token is what the shopper's order link carries (GET /store/orders/{id}?token=).

create_account: true from a guest asks for an account with the cart's email once the order is placed, with password (8 to 128 characters, 422 without create_account) or, without one, a link to choose it by email (app/commerce/accounts.py). It runs once the answer is sent, on the first answer and on every retry, never makes a second account and never changes the answer, so the answer does not say whether the email already had an account.

application/json

GET /api/v1/orgs/{org_slug}/store/carts/{cart_id}/fees

Every fee the cart is offered, with selected: the same list as the cart's fees.

POST /api/v1/orgs/{org_slug}/store/carts/{cart_id}/fees/{code}

Select an offered fee. 404 not_found for a code the cart is not offered.

DELETE /api/v1/orgs/{org_slug}/store/carts/{cart_id}/fees/{code}

Turn an offered fee off; the choice is kept even for a fee on by default.

POST /api/v1/orgs/{org_slug}/store/carts/{cart_id}/gift-cards

Apply a gift card by its code: 10 attempts per 10 minutes per cart and per client IP.

application/json (required)

DELETE /api/v1/orgs/{org_slug}/store/carts/{cart_id}/gift-cards/{gift_card_id}

POST /api/v1/orgs/{org_slug}/store/carts/{cart_id}/line-items

Add a variant; the same variant with the same metadata merges into its line.

application/json (required)

PATCH /api/v1/orgs/{org_slug}/store/carts/{cart_id}/line-items/{line_id}

Set a line's quantity; 0 removes it.

application/json (required)

DELETE /api/v1/orgs/{org_slug}/store/carts/{cart_id}/line-items/{line_id}

GET /api/v1/orgs/{org_slug}/store/carts/{cart_id}/payment-providers

The providers that can take this cart's payment, and whether it needs one.

POST /api/v1/orgs/{org_slug}/store/carts/{cart_id}/payment-sessions

Start the payment with provider, or refresh the one already started for the same amount. accept_terms records the shopper's acceptance of the store's terms with the session.

application/json (required)

POST /api/v1/orgs/{org_slug}/store/carts/{cart_id}/promotions

Apply a code. 422 promotion_not_applicable says why in reason.

application/json (required)

DELETE /api/v1/orgs/{org_slug}/store/carts/{cart_id}/promotions

Remove a code, named in the body {"code"} or as ?code=.

application/json

POST /api/v1/orgs/{org_slug}/store/carts/{cart_id}/shipping-methods

Choose an option; it replaces the method its shipping profile had.

application/json (required)

GET /api/v1/orgs/{org_slug}/store/carts/{cart_id}/shipping-options

The options the cart's address and items allow, priced for them, per shipping profile.

GET /api/v1/orgs/{org_slug}/store/categories

The active, public categories as a tree. A category that is inactive or internal hides the categories under it too.

GET /api/v1/orgs/{org_slug}/store/categories/{handle}

GET /api/v1/orgs/{org_slug}/store/collections

GET /api/v1/orgs/{org_slug}/store/collections/{handle}

A published collection; its products are /store/products?collection_handle=.

POST /api/v1/orgs/{org_slug}/store/leads

Record a sign-up. Always {"ok": true} for a valid address.

application/json (required)

POST /api/v1/orgs/{org_slug}/store/leads/impressions

One more view of a popup design today (UTC).

application/json (required)

POST /api/v1/orgs/{org_slug}/store/orders/lookup

Email the links to the orders placed with email (in the key's mode, within the store's order link lifetime). Always {"sent": true}; the email goes out after the answer, and only when there are orders.

application/json (required)

GET /api/v1/orgs/{org_slug}/store/orders/{order_id}

GET /api/v1/orgs/{org_slug}/store/orders/{order_id}/documents

The invoice and credit notes, as issued by the seller of record.

GET /api/v1/orgs/{org_slug}/store/orders/{order_id}/returns

The order's returns, oldest first.

POST /api/v1/orgs/{org_slug}/store/orders/{order_id}/returns

Ask to return shipped units, or to exchange them: requested until the store approves or declines it.

application/json (required)

GET /api/v1/orgs/{org_slug}/store/regions

The regions the store sells in, to pick a country and currency from.

GET /api/v1/orgs/{org_slug}/store/regions/{region_id}

GET /api/v1/orgs/{org_slug}/store/return-reasons

The reasons a shopper may pick for a return, in the store's order, leaving out those it disabled. An item's reason_code takes a code.

POST /api/v1/orgs/{org_slug}/store/unsubscribe

Suppress the token's address for this store's marketing emails. No publishable key.