Update a store
Authorization
bearerAuth In: header
Path Parameters
Id of a physical store. The id is required when retailer want to make a call to specified store.
Request Body
application/json
Unique identifier across all AiFi stores. it will only be filled in by TechOPS/deployment engineers
Status of a store, indicates whether the store is open to customers
"OPEN" | "CLOSED" | "CLOSED_FOR_MAINTENANCE"Deployment status of a store, indicated whether the store is live, under deployment or testing
"LIVE" | "TESTING" | "DEPLOYMENT" | "DECOMMISSIONED"How many people can be at the store at the same time
On-premise api url of a store
uriA combination of retailer name, city and country mainly used in aifi internally, it's not very friendly to customer, so the field displayableName will be used as store name in SMS notification
Store name from customer perspective, displayableName is a value set in the DB or a default of using store.name
External id of a store, retailers can specify their own id for the store via this field
We would send this field in the payload of checkout webhook with key storeExternalId
For example, we will include "storeExternalId": "store0001" in the payload of checkout webhook if retailer specifies this field with "store0001" if you send null for this variable, it'll clear thirdPartyId
Address of a store, including details such as: street name, building number, floor, etc
City of the address
The region of the address, such as the province, state, or district
Country code of the address. it's a ISO_3166-1_alpha-2 code
"AC" | "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AN" | "AO" | "AR" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BF" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BV" | "BW" | "BY" | "BZ" | "CA" | "CC" | "CD" | "CF" | "CG" | "CH" | "CI" | "CK" | "CL" | "CM" | "CN" | "CO" | "CR" | "CU" | "CV" | "CW" | "CX" | "CY" | "CZ" | "DE" | "DJ" | "DK" | "DM" | "DO" | "DZ" | "EC" | "EE" | "EG" | "EH" | "ER" | "ES" | "ET" | "FI" | "FJ" | "FK" | "FO" | "FR" | "GA" | "GB" | "GD" | "GE" | "GF" | "GG" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GR" | "GS" | "GT" | "GW" | "GY" | "HK" | "HM" | "HN" | "HR" | "HT" | "HU" | "ID" | "IE" | "IL" | "IM" | "IN" | "IO" | "IQ" | "IR" | "IS" | "IT" | "JE" | "JM" | "JO" | "JP" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KP" | "KR" | "KW" | "KY" | "KZ" | "LA" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MA" | "MC" | "MD" | "ME" | "MF" | "MG" | "MK" | "ML" | "MM" | "MN" | "MO" | "MQ" | "MR" | "MS" | "MT" | "MU" | "MV" | "MW" | "MX" | "MY" | "MZ" | "NA" | "NC" | "NE" | "NF" | "NG" | "NI" | "NL" | "NO" | "NP" | "NR" | "NU" | "NZ" | "OM" | "PA" | "PE" | "PF" | "PG" | "PH" | "PK" | "PL" | "PM" | "PN" | "PS" | "PT" | "PY" | "QA" | "RE" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SC" | "SD" | "SE" | "SG" | "SH" | "SI" | "SJ" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SV" | "SX" | "SY" | "SZ" | "TA" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TL" | "TM" | "TN" | "TO" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "UM" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VG" | "VN" | "VU" | "WF" | "WS" | "XK" | "YE" | "YT" | "ZA" | "ZM" | "ZW"Postal code of the address.
Response Body
application/json
application/json
curl -X PATCH "https://oasis-api.public.sandbox.oasis.aifi.com/api/admin/v2/stores/0" \ -H "Content-Type: application/json" \ -d '{}'{
"aifiUniqueStoreId": "string",
"status": "OPEN",
"deploymentStatus": "LIVE",
"addressLine1": "string",
"addressCity": "string",
"addressRegion": "string",
"addressCountry": "AC",
"addressPostalCode": "string",
"store": {
"oasisApiStoreId": 0,
"aifiUniqueStoreId": "string"
},
"thirdPartyId": "string",
"storeUrl": "string",
"maxPeople": 0,
"storeConfigId": 0,
"externalId": "string",
"health": "online",
"address": {},
"id": 0,
"name": "string",
"displayableName": "string"
}{
"message": "Invalid request body",
"type": "E_INVALID_BODY",
"errors": [
{
"error": "\"email\" is required",
"rule": "any.required",
"field": "\"email\""
}
]
}How is this guide?