List the tenant's printshop connections

GET

/v1/printshop-connections

const url = 'https://api.pixonaut.app/v1/printshop-connections';
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://api.pixonaut.app/v1/printshop-connections \
  --header 'Authorization: Bearer <token>'

Operation ID: printshopConnections.list

Each connection’s id, name, adapter, whether it is active and whether it is the tenant’s default printshop, active first; a member is also answered its counts: the blanks it makes, its open orders and all its orders, blanks null without blanks:read and the order counts null without orders:read. q keeps the connections whose name holds it, case aside.

Authorizations

secretKey
integrationKey

Parameters

Query Parameters

string

<= 200 characters

Responses

200

The connections, active first, and the adapters available. A key is answered each connection’s id, name, adapter, whether it is active and whether it is the default, and nothing else.

application/json

Any of:

object
object

object

adapters

required

Array<object>

object

adapter

required

string

catalogue

required

boolean

categories

required

boolean

consent

required

object

configured

required

boolean

credentialGuide

required

object

configFields

Array<object>

object

name

required

string

requiredPermissions

required

Array<string>

tokenPageUrl

required

string

deliverySteps

required

boolean

machineProfiles

required

boolean

partnerPhotos

required

boolean

placeholders

required

Array<string>

spotPlates

required

boolean

takesContact

required

boolean

available

required

Array<string>

connections

required

Array<object>

object

acceptsAddressUpdates

required

Whether its merchant says it takes an order’s address after the order was sent; read when addressChanges is by_setting.

boolean

active

required

boolean

adapter

required

string

address

required

The printshop’s own address, for its contact details; null for none. Never where an order ships.

object

city

required

The city or town.

string

>= 1 characters <= 100 characters

company

The company of a business address, which the parcel goes to; the recipient is who receives it.

string

>= 1 characters <= 200 characters

country

required

The country as a two-letter ISO 3166-1 code in capitals, such as SE or US.

string

/^[A-Z]{2}$/

line1

required

The first line of the street address: street and number.

string

>= 1 characters <= 200 characters

line2

The second line of the address: an apartment, floor or c/o.

string

>= 1 characters <= 200 characters

postalCode

The postal code as the country writes it, such as 111 22 or SW1A 1AA. Left out where the country has none; a printshop that needs one refuses the order postal_code_required.

string

>= 1 characters <= 20 characters

region

The state, province or county, where the country uses one.

string

>= 1 characters <= 100 characters

addressChanges

required

Whether an order’s address may change after it was sent: always for a printshop whose integration tells it, by_setting when acceptsAddressUpdates decides, null for never.

string | null

config

contactEmail

required

The contact person’s email address; null for none. A delivery step may send to it as {printshop.contact.email}.

string | null format: email

<= 254 characters

contactEmailBounced

required

Whether mail to contactEmail bounced, so none is sent to it until the address changes.

boolean

contactName

required

The name of the person to reach at the printshop. Up to 200 characters; null for none.

string | null

>= 1 characters <= 200 characters

contactPhone

required

The contact person’s phone number as written; null for none.

string | null

>= 1 characters <= 50 characters

counts

required

object

blanks

required

integer | null

openOrders

required

integer | null

orders

required

integer | null

createdAt

required

number

credentialsLapsed

required

Whether its printshop refused to renew its credentials: it needs its merchant to connect it again through the printshop’s consent.

boolean

required

string

isDefault

required

boolean

name

required

string

needsPositions

required

boolean

paused

required

boolean

printMethods

required

Array<string>

printMethodsFixed

required

boolean

secretNames

required

Array<string> | null

updatedAt

required

number

Examples

example

Example

{
  "connections": [
    {
      "active": true,
      "adapter": "printful",
      "id": "psc_north",
      "isDefault": true,
      "name": "Northern Print"
    },
    {
      "active": true,
      "adapter": "custom",
      "id": "psc_south",
      "isDefault": false,
      "name": "Southside Print"
    }
  ]
}

Headers

X-Request-Id

required

string

Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.

401

Refused: unauthorized

application/json

object

error

required

string

Examples

unauthorized

{
  "error": "unauthorized"
}

Headers

X-Request-Id

required

string

403

Refused: origin_forbidden, forbidden, feature_disabled, workspace_suspended

application/json

object

error

required

string

feature

The feature the tenant does not have. Always sent with feature_disabled.

string

Examples

feature_disabled

{
  "error": "feature_disabled",
  "feature": "api"
}

forbidden

{
  "error": "forbidden"
}

origin_forbidden

{
  "error": "origin_forbidden"
}

workspace_suspended

{
  "error": "workspace_suspended"
}

Headers

X-Request-Id

required

string

422

Refused: invalid_query

application/json

object

error

required

string

Examples

invalid_query

{
  "error": "invalid_query"
}

Headers

X-Request-Id

required

string

500

Refused: db_error. A request that failed unexpectedly answers as text instead.

object

error

required

string

Examples

db_error

{
  "error": "db_error"
}

Headers

X-Request-Id

required

string

Questions? Write to [email protected].

Status · Terms of service · Privacy policy · Subprocessors