Store Cards

Store card represents information about your stores. On this page, we’ll dive into the different store card endpoints you can use to manage your store cards programmatically. We'll look at how to upload and update store cards.

The Store Card model

The store card model contains all the information about your stores, including the email, structure node key, store concept code and open hours info.

Properties

Name
nodeKey
Type
string
Description
Unique identifier for the structure node.
Name
email
Type
string
Description
The contact email of the store.
Name
storeConceptCode
Type
number | null
Description
The code of one of concepts that you registered in the system.
Name
opentToGuestsPeriod
Type
object
Description
The information about close / open hours of the store.

The Open to Guest Period model

The store card model contains all the information about your stores, including the email, structure node key, store concept code and open hours info.

Properties

Name
from 0 to 6
Type
object
Description
The object with properties from 0 to 6 (each number represents a weekday in order from sunday to saturday) with object of type { 'since': number, 'to': number } in each. since field represents the store opening hour (from 6 to 23) and to field represents the store close hour (from 8 to 30).

POST/integrations/storeCards

Update all store cards

This endpoint allows you to upload all your store cards. It replaces all the existing cards with uploaded ones. See the code examples for how to upload your Store Cards through ProShedule API.

Required attributes

Name
body
Type
Array<storeCard>
Description
An array of store card objects.

Request

POST

/integrations/storeCards

curl https://api.proschedule.ambraisoft.com/integrations/storeCards \
  --header "Content-Type: application/json" \
  --header "Authorization: Bearer {token}" \
  --data-raw '[
    {
      "nodeKey": "000",
      "email": "test@email.com",
      "storeConceptCode": 0,
      "opentToGuestsPeriod": {
        "0": {
            "since": 8.5,
            "to": 22
        },
        "1": {
            "since": 8.5,
            "to": 22
        },
        "2": {
            "since": 8.5,
            "to": 22
        },
        "3": {
            "since": 8.5,
            "to": 22
        },
        "4": {
            "since": 8.5,
            "to": 28
        },
        "5": {
            "since": 8.5,
            "to": 22
        },
        "6": {
            "since": 8.5,
            "to": 22
        }
      }
    }
  ]'

Response

  {
      "message": "1 store card(s) uploaded",
      "status": 200
  }