Skip to main content

Merchant Status

Merchant Status​

Retrieves the status of a specific merchant by external ID.

Endpoint:

GET /company/merchants/{external_id}

Authorization: Bearer <ACCESS_TOKEN>

Response:

{
    "success": true,
    "data": {
        "id": "<id>",
        // id provided by the provider
        "external_id": "<provided-id>",
        // the last time data was updated, if no data this field will be `undefined`
        "latest_update": "2008-01-10T11:00:00Z",
        // true only if one or more stores have ongoing fetch at the moment.
        "is_fetching": true,
        "stores": [
            {
                "id": "507f191e810c19729de860c1",
                // the store type "SHOPIFY" | "AMAZON" | ...
                "type": "SHOPIFY",
                "name": "shop abc",
                // one of: 'QUEUED' | 'FETCHING' | 'READY' | 'DISCONNECTED' | 'ERRORED'
                "status": "READY"
            },
            {
                "id": "7f97823810c1629de191e0ea",
                "type": "AMAZON",
                "name": "shop xyz",
                "status": "QUEUED"
            }
        ]
    }
}

Fields

id​

Unique id for that merchant.

external_id​

The id provided by the provider.

latest_update​

The last time data was updated, if no data this field will be undefined

is_fetching​

True only if one or more stores have ongoing fetch at the moment.

stores​

An array of stores for that merchant.