Admin api stores

Get zones

GET
/api/admin/v2/stores/{storeId}/zones

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

storeId*integer

Id of a physical store. The id is required when retailer want to make a call to specified store.

Query Parameters

label?array<>

If provided filters result list by zone labels

Default[]

Response Body

application/json

application/json

curl -X GET "https://oasis-api.public.sandbox.oasis.aifi.com/api/admin/v2/stores/0/zones"
[
  {
    "id": "string",
    "labels": [
      "none"
    ],
    "name": "string"
  }
]
Empty
{
  "message": "Invalid request body",
  "type": "E_INVALID_BODY",
  "errors": [
    {
      "error": "\"email\" is required",
      "rule": "any.required",
      "field": "\"email\""
    }
  ]
}

How is this guide?

Upsert tags PUT

Previous Page

request to third party with cart mutation POST

AiFi system shall call this webhook when a customer checked out in a store and an order is being placed in AiFi system. The webhook is also called when an order's contest is reviewed. Important notes about calling webhook during a contest: * it can happen even a few days later after the actual shopping journey. Retailer should use timeOfOrigin (time of the original shopping journey) * items that were previously added by the webhook during the checkout will not be sent again during review! * calling webhook during review can be distinguished by status field. * by default reviewedTotalPrice takes precedence over cart mutator totalPrice. Cart Mutator implementation should respect and properly handle adjusted reviewedTotalPrice. The webhook expects that the third party system is going to mutate cart items and adjust order prices according to the cart mutation. Possible use cases include: extending items with taxLines adding deposit items adjusting prices and removing or adding new cart items. Some communication details: * when response couldn't be received or crucial fields are missing Aifi system **fails silently** (mutator webhook is omitted) * when only some particular cart item in response is incorrect Aifi system ignores that item (for example when neither id nor externalId of cart item couldn't be resolved to AiFi object) **Note**: as an integrator the URL you specify for this webhook is going to be exactly the URL that will be called. For example if you specify "http://example-retailer-api.com/webhook" then exactly "http://example-retailer-api.com/webhook" will be called.

AiFI AI Chat

Beta

Powered by AiFi

Ask docs or API questions to get grounded answers.