Articles in this section

See more

Get POS Vendor Resources

Avatar
John Twomey
  • Updated
Follow

Retrieve resources for a given POS Vendor.

GET ~/resources/vendors/:vendor-id

Parameters

Field Type Description
:vendor-id String

The ID of the POS Vendor.

Response

Field Type Description
resources Object[]

A list of resources associated to the specified POS Vendor
  id String

Resource id in Doshii
  name String

The human-readable name of the resource
  mimeType String

The mime type of the resource being created
  type String

Indicates how the resource is stored and retrieved.

type description
doshii-uri The binary resource is hosted by Doshii and the resource is retrieved using the Doshii API
external-uri The binary resource is hosted externally and the resource property contains the URI to access the resource
  context String

A free-text string to describe the purpose of the resource, e.g logo, user manual, etc
  private boolean

Indicates whether or not associated Apps can access this resource. Default is false, meaning the resource is available to view by any App that is subscribed
  resource String

This property provides the URI for how to retrieve the binary resource. This could refer to an external URI if the resource type is external-uri
  relations Object

An object describing each of the entity relationships for this resource. For example, a generic logo could be used by multiple locations, rather than each location having a duplicate image
    locations String[]

A list of hashed location IDs linked to this resource. See Hashed Location IDs
    apps String[]

A list of App IDs linked to this resource
    vendors String[]

A list of Vendors IDs linked to this resource
    menuProducts Object[]

A list of menu products linked to this resource
      locationId String

The hashed location ID that is associated to the menu item. See Hashed Location IDs
      posId String

The posId of the menu item
  createdAt String

Date when the resource was created

Examples

Response

{
    "resources": [{
        "id": "lLf2X0k6",
        "name": "pizza.png",
        "mimeType": "image/png",
        "context": "logo",
        "type": "doshii-uri",
        "resource": "https://sandbox.pos.doshii.co/v3/resources/lLf2X0k6",
        "createdAt": "2018-08-20T03:14:39.374Z",
        "relations": {
            "apps": [123]
            "locations": ["2X3b8q"]
            "menuProducts": [{
                "locationId": "2X3b8q",
                "posId": "pizza"
            }],
            "vendors": [456]
        }
    }]
}

 

Related articles

Comments

0 comments

Please sign in to leave a comment.