Where connecting a store stands: its step and what it shows

GET

/api/v1/workspaces/{workspace}/stores/{id}/connect

package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "https://reputecast.example.com/api/v1/workspaces/acme-newsletter/stores/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/connect"

  req, _ := http.NewRequest("GET", url, nil)

  req.Header.Add("Authorization", "Bearer <token>")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

const url = 'https://reputecast.example.com/api/v1/workspaces/acme-newsletter/stores/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/connect';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://reputecast.example.com/api/v1/workspaces/acme-newsletter/stores/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/connect \
  --header 'Authorization: Bearer <token>'

Permission: integrations:view

Authorizations

bearer

Parameters

Path Parameters

workspace

required

Workspace slug

string

/^[a-z0-9][a-z0-9-]{1,62}$/

Workspace slug

required

The store’s id

string format: uuid

The store’s id

Responses

200

application/json

object

appUrl

required

string

clientIdHint

string

demo

required

boolean

error

required

string

Allowed values: "" secret_refused state_expired not_installed

granted

required

Array<string>

installedAt

string format: date-time

keyHint

string

lists

required

Array<object>

object

required

string

members

required

integer format: int64

name

required

string

store

required

boolean

months

required

integer format: int64

newListName

required

string

optionalScope

required

string

plugin

object

checkedAt

string format: date-time

checkouts

required

boolean

consent

required

boolean

found

required

boolean

host

required

string

siteId

string

skipped

required

boolean

version

string

reachable

required

boolean

reachableCheckedAt

string format: date-time

redirectUrl

required

string

scopes

required

Array<string>

step

required

string

Allowed values: address app keys install sync key webhooks plugin done

store

required

object

address

required

string

currency

required

string

demo

required

boolean

domain

required

string

required

string

listId

string

listName

string

name

required

string

platform

required

string

Allowed values: shopify woocommerce

products

required

integer format: int64

status

required

string

Allowed values: connecting importing connected disconnected

step

required

string

sync

required

object

disconnectedAt

string format: date-time

disconnectedBy

string

import

object

accepted

required

integer format: int64

collections

required

integer format: int64

customers

required

object

done

required

integer format: int64

total

required

integer format: int64

customersSkipped

required

boolean

finishedAt

string format: date-time

known

required

integer format: int64

matching

required

object

done

required

integer format: int64

total

required

integer format: int64

minutesLeft

required

integer format: int64

months

required

integer format: int64

notAdded

required

integer format: int64

orders

required

object

done

required

integer format: int64

total

required

integer format: int64

phase

required

string

Allowed values: products customers orders matching done

products

required

object

done

required

integer format: int64

total

required

integer format: int64

startedAt

required

string format: date-time

startedBy

required

string

lastEventAt

string format: date-time

missing

required

Array<string>

missingSince

string format: date-time

rateLimitedUntil

string format: date-time

revokedAt

string format: date-time

revokedReason

required

string

Allowed values: "" uninstalled revoked

state

required

string

Allowed values: connecting importing connected webhook_missing rate_limited no_plugin disconnected

syncs

required

object

checkouts

required

boolean

customers

required

boolean

listId

string

orders

required

boolean

products

required

boolean

writeBack

required

boolean

webhooks

required

integer format: int64

writeGranted

required

boolean

Example

{
  "error": "",
  "step": "address",
  "store": {
    "platform": "shopify",
    "status": "connecting",
    "sync": {
      "import": {
        "phase": "products"
      },
      "revokedReason": "",
      "state": "connecting"
    }
  }
}

default

Error

application/problem+json

object

code

Stable error code, e.g. permission_denied

string

detail

A human-readable explanation specific to this occurrence of the problem.

string

errors

Optional list of individual error details

Array<object>

object

location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string

message

Error message text

string

value

The value at the given location

helpers

Members who hold the missing permission

Array<string>

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri

meta

object

key

additional properties

permission

The missing permission key

string

status

HTTP status code

integer format: int64

title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference to human-readable documentation for the error.

string format: uri

default: about:blank

Example

{
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}