Skip to content

Stores

Rereive information about the Merchant Stores.

Store API will helps to create and manage all stores under the merchant.

The store node

Method Type Description
id ID! Primary key
extraInfo JSONString
isActive Boolean! whether the store is active?
createdAt DateTime!
updatedAt DateTime!
deletedAt DateTime
merchant MerchantNode
name String! Name of the store
location String
phoneNumber String!
country String
state String
city String
street String
zipCode String
taxRate Float
shortDescription String
longDescription String
color String!
deliveryCostPerMileCurrency StoreDeliveryCostPerMileCurrency
deliveryCostPerMile String
deliveryDistanceLimitMiles Float
totalRating Float!
storeType TypeNode
disableOnlineOrders Boolean
categories CategoryNodeConnection!
logo String
orderPreparationTimeHours Float
merchants IUserNodeConnection!
groups StoreGroupNodeConnection!
pictures StorePictureNodeConnection!
schedules StoreAvailabilityNodeConnection!
customDates StoreCustomDateNodeConnection!
products ProductNodeConnection!
productsQuantities ProductQuantityNodeConnection!
productsAvailabilities ProductAvailabilityNodeConnection!
campaigns CampaignNodeConnection!
offers OfferNodeConnection!
loyaltyCards LoyaltyCardNodeConnection!
visits VisitNodeConnection!
floorPlans FloorPlanNodeConnection!
sections SectionNodeConnection!
orders OrderNodeConnection!
pk Int
address String
pointsEarned Int
reviews ReviewNodeConnection
favorites FavoriteNodeConnection
countryDisplay String
isOpen Boolean
deliveryCostPerMileAmount Float
currentCustomDates StoreCustomDateNodeConnection

Create a store

mutation (
    $name: String!
    $shortDescription: String
    $longDescription: String
    $location: String!
    $phoneNumber: String!
    $storeType: ID!
    $categories: [ID]!
    $logo: Upload
    $pictures: [StoreImageInput]!
    $country:String
    $state: String
    $city: String
    $street: String
    $zipCode: String
    $taxRate: Float
    $orderPreparationTimeHours: Float
    $deliveryCostPerMile: Decimal
    $deliveryCostPerMileCurrency: String
    $deliveryDistanceLimitMiles: Float
    $schedules: [StoreAvailabilityInput]!
    $customDates: [StoreCustomDateInput]
){
    createStore(
        input: {
            name: $name
            shortDescription: $shortDescription
            longDescription: $longDescription
            location: $location
            phoneNumber: $phoneNumber
            storeType: $storeType
            categories: $categories
            logo: $logo
            pictures: $pictures
            country: $country
            state: $state
            city: $city
            zipCode: $zipCode
            street: $street
            taxRate: $taxRate
            orderPreparationTimeHours: $orderPreparationTimeHours
            deliveryCostPerMile: $deliveryCostPerMile
            deliveryCostPerMileCurrency: $deliveryCostPerMileCurrency
            deliveryDistanceLimitMiles: $deliveryDistanceLimitMiles
            schedules: $schedules
            customDates: $customDates
        }
    ) {
        success
        errors
        store {
            id
        }
    }
}

{
    "name": "Test store",
    "shortDescription": "",
    "longDescription": "",
    "location": "36.3633,6.6133",
    "phoneNumber": "+12125552368",
    "storeType": 4,
    "categories": [2],
    "logo": "",
    "pictures": [],
    "taxRate": 0.5,
    "orderPreparationTimeHours": 0.5,
    "deliveryCostPerMile": "1.00",
    "deliveryDistanceLimitMiles": 2,
    "schedules": [
        {"day": 1, "startTime": "7:00", "endTime": "12:00"},
        {"day": 1, "startTime": "12:00", "endTime": "20:00"}
    ],
    "customDates": [
        {"description": "Easter Holiday", "start": "2022-04-17", "end": "2022-04-18"}
    ]
}

{
    "data": {
        "createStore": {
            "success": true,
            "errors": null,
            "store": {
                "id": "U3RvcmVOb2RlOjEzMQ=="
            }
        }
    }
}

Update a store

mutation (
    $id: ID!
    $name: String
    $location: String
    $phoneNumber: String
    $country: String
    $state: String
    $city: String
    $street: String
    $zipCode: String
    $taxRate: Float
    $shortDescription: String
    $longDescription: String
    $storeType: ID
    $categories: [ID]
    $deliveryCostPerMile: Decimal
    $deliveryCostPerMileCurrency: String
    $deliveryDistanceLimitMiles: Float
    $disableOnlineOrders: Boolean
    $orderPreparationTimeHours: Float
    $pictures: [StoreImageInput]
    $schedules: [StoreAvailabilityInput]
    $customDates: [StoreCustomDateInput]
    $logo: Upload
){
    updateStore(
        input: {
            id: $id
            name: $name
            location: $location
            phoneNumber: $phoneNumber
            country: $country
            state: $state
            city: $city
            street: $street
            zipCode: $zipCode
            taxRate: $taxRate
            shortDescription: $shortDescription
            longDescription: $longDescription
            storeType: $storeType
            categories: $categories
            deliveryCostPerMile: $deliveryCostPerMile
            deliveryCostPerMileCurrency: $deliveryCostPerMileCurrency
            deliveryDistanceLimitMiles: $deliveryDistanceLimitMiles
            disableOnlineOrders: $disableOnlineOrders
            orderPreparationTimeHours: $orderPreparationTimeHours
            pictures: $pictures
            schedules: $schedules
            customDates: $customDates
            logo: $logo
        }
    ) {
        success
        errors
        store {
            id
        }
    }
}

{
    "id": 131,
    "name": "Edited store name"
}

{
    "data": {
        "updateStore": {
            "success": true,
            "errors": null,
            "store": {
                "id": "U3RvcmVOb2RlOjEzMQ=="
            }
        }
    }
}

Delete a store

mutation (
    $id: ID!
){
    deleteStore(
        input: {
            id: $id
        }
    ) {
        success
        errors
    }
}

{
    "id": 131
}

{
    "data": {
        "deleteStore": {
            "success": true,
            "errors": null,
        }
    }
}

List stores

query {
    stores{
        edges {
            node {
                pk
                id
            }
        }
    }
}

Get a single store

query {
    store(id: "U3RvcmVOb2RlOjE5"){
        pk
        id
        name
    }
}