StorePrinter

StorePrinter

List printers for store

get

/tenants/{tenantUid}/stores/{storeUid}/printers

List printers for store

Authorizations

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+

tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

Query parameters

pageSizeintegerOptional

The number of items per page in a result set.

pageNumberintegerOptional

Reference to a specific page in a result set.

sortBystringOptional

Defines which field the resource list is sorted by.

sortDirectionstring · enumOptional

ENUM	Description
ASC	Sort in ascending order
DESC	Sort in descending order

Possible values:

Responses

200

Example response

application/json

get/tenants/{tenantUid}/stores/{storeUid}/printers

GET /v2/tenants/{tenantUid}/stores/{storeUid}/printers HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "items": [
    {
      "store": {
        "name": "text",
        "storeUid": "text",
        "organizationUid": "text",
        "organizationName": "text"
      },
      "printer": {
        "printerUid": "text",
        "name": "text",
        "type": "LABEL",
        "availablePrintActions": [
          "RECEIPT"
        ]
      },
      "eventType": "PICKUP_LABEL",
      "storePrinterUid": "text"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Assign printer to store and add an event type

post

/tenants/{tenantUid}/stores/{storeUid}/printers

Assign an event type to a printer and store

Required permissions: PRINTER

Authorizations

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+

tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

Body

printerUidstringRequiredPattern: ^[A-Za-z0-9-_]+

eventTypestring · enumRequiredPossible values:

storePrinterUidstringOptionalPattern: ^[A-Za-z0-9-_]+

Responses

201

Example response

application/json

eventTypestring · enumRequiredPossible values:

storePrinterUidstringRequiredPattern: ^[A-Za-z0-9-_]+

post/tenants/{tenantUid}/stores/{storeUid}/printers

POST /v2/tenants/{tenantUid}/stores/{storeUid}/printers HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 73

{
  "printerUid": "text",
  "eventType": "PICKUP_LABEL",
  "storePrinterUid": "text"
}

201

Example response

{
  "store": {
    "name": "text",
    "storeUid": "text",
    "organizationUid": "text",
    "organizationName": "text"
  },
  "printer": {
    "printerUid": "text",
    "name": "text",
    "type": "LABEL",
    "availablePrintActions": [
      "RECEIPT"
    ]
  },
  "eventType": "PICKUP_LABEL",
  "storePrinterUid": "text"
}

Get Store Printer Details

get

/tenants/{tenantUid}/stores/{storeUid}/printers/{storePrinterUid}

Get Store Printer Details

Authorizations

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+

storePrinterUidstringRequired

Reference to a storePrinterUid

Responses

200

Example response

application/json

eventTypestring · enumRequiredPossible values:

storePrinterUidstringRequiredPattern: ^[A-Za-z0-9-_]+

get/tenants/{tenantUid}/stores/{storeUid}/printers/{storePrinterUid}

GET /v2/tenants/{tenantUid}/stores/{storeUid}/printers/{storePrinterUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "store": {
    "name": "text",
    "storeUid": "text",
    "organizationUid": "text",
    "organizationName": "text"
  },
  "printer": {
    "printerUid": "text",
    "name": "text",
    "type": "LABEL",
    "availablePrintActions": [
      "RECEIPT"
    ]
  },
  "eventType": "PICKUP_LABEL",
  "storePrinterUid": "text"
}

Update Store Printer Details

put

/tenants/{tenantUid}/stores/{storeUid}/printers/{storePrinterUid}

Update Store Printer Details

Required permissions: PRINTER

Authorizations

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+

storePrinterUidstringRequired

Reference to a storePrinterUid

Body

printerUidstringOptionalPattern: ^[A-Za-z0-9-_]+

eventTypestring · enumOptionalPossible values:

Responses

200

Example response

application/json

eventTypestring · enumRequiredPossible values:

storePrinterUidstringRequiredPattern: ^[A-Za-z0-9-_]+

put/tenants/{tenantUid}/stores/{storeUid}/printers/{storePrinterUid}

PUT /v2/tenants/{tenantUid}/stores/{storeUid}/printers/{storePrinterUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "printerUid": "text",
  "eventType": "PICKUP_LABEL"
}

200

Example response

{
  "store": {
    "name": "text",
    "storeUid": "text",
    "organizationUid": "text",
    "organizationName": "text"
  },
  "printer": {
    "printerUid": "text",
    "name": "text",
    "type": "LABEL",
    "availablePrintActions": [
      "RECEIPT"
    ]
  },
  "eventType": "PICKUP_LABEL",
  "storePrinterUid": "text"
}

Delete Store Printer Details

delete

/tenants/{tenantUid}/stores/{storeUid}/printers/{storePrinterUid}

Delete Store Printer Details Required permissions: PRINTER

Authorizations

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+

storePrinterUidstringRequired

Reference to a storePrinterUid

Responses

204

No Content

No content

delete/tenants/{tenantUid}/stores/{storeUid}/printers/{storePrinterUid}

DELETE /v2/tenants/{tenantUid}/stores/{storeUid}/printers/{storePrinterUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

No Content

No content