Get a store
The store with its import progress.
GET
The store with its import progress.
apiKey readheader
AuthorizationBearer <token>A workspace API key (pf_…), created under Developers → API keys.
Scope: read
id*stringFormat
uuidOK
application/json- response
id*stringFormat
uuidplatform*stringValue in
"shopify""custom"name*stringexternalId*stringcurrency*stringprimaryLocale*stringstatus*stringValue in
"active""disconnected"connectionStatus*stringValue in
"connected""needs_reauth""disconnected"importStatus*stringValue in
"none""queued""running""completed""failed"permissions*connectedAt*stringFormat
date-timestorefrontUrl*|Format
uricontactEmail*string|nulllocaleCount*integercustomerCount*integerorderCount*integerproductCount*integerlastOrderAt*|Format
date-timelastProductSyncAt*|Format
date-timeimports*latestCustomer*|nulladminUrl*stringFormat
uricurl -X GET 'https://api.postforge.dev/v1/stores/497f6eca-6276-4993-bfeb-53cbbbba6f08'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "platform": "shopify", "name": "string", "externalId": "string", "currency": "string", "primaryLocale": "string", "status": "active", "connectionStatus": "connected", "importStatus": "none", "permissions": { "coupons": true, "consent": true }, "connectedAt": "2019-08-24T14:15:22Z", "storefrontUrl": "http://example.com", "contactEmail": "string", "localeCount": 0, "customerCount": 0, "orderCount": 0, "productCount": 0, "lastOrderAt": "2019-08-24T14:15:22Z", "lastProductSyncAt": "2019-08-24T14:15:22Z", "imports": { "customersOrders": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "scope": "customers_orders", "status": "queued", "stage": "customers", "requestedBy": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "imported": { "customers": 0, "orders": 0, "products": 0 }, "error": "store_unreachable", "queuedAt": "2019-08-24T14:15:22Z", "startedAt": "2019-08-24T14:15:22Z", "completedAt": "2019-08-24T14:15:22Z" }, "products": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "scope": "customers_orders", "status": "queued", "stage": "customers", "requestedBy": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "imported": { "customers": 0, "orders": 0, "products": 0 }, "error": "store_unreachable", "queuedAt": "2019-08-24T14:15:22Z", "startedAt": "2019-08-24T14:15:22Z", "completedAt": "2019-08-24T14:15:22Z" } }, "latestCustomer": { "profileId": "faebe71b-2bf8-4bdb-9b67-258e4d6aa00a", "name": "string", "createdAt": "2019-08-24T14:15:22Z" }, "adminUrl": "http://example.com"}