Arryved Partner APIs (1.0.5)

Download OpenAPI specification:Download

E-mail: integrations@arryved.com License: Apache 2.0

Introduction

Arryved offers a comprehensive Point-of-Sale (POS) system for all kinds of service businesses, from bars & taprooms to music venues (and everything in between). Please visit our website to find out more about the company.

This is the API documentation for Arryved Partners. This API is developed for the purpose of providing external clients with a limited set of functionality provided by our core POS system, such as inventory counts and sales data. Read on to find out more!

If you are not currently a partner and would like to be, please contact us at integrations@arryved.com in order to get started.

Accounting

List all sales (defaults to sales for the prior day unless the optional query param 'date' is supplied)

Authorizations:

ApiKeyAuth

query Parameters

date	string <date> OPTIONAL: The date (YYYY-MM-DD format) to restrict sales to; if not present, will default to yesterday's date
pageSize	integer <int64> >= 1 Example: pageSize=10 Number of items per page
pageNumber	integer <int64> >= 1 Example: pageNumber=1 Which page to return

Request Body schema: application/json

required

object (RequestInfoDto)

Records basic details about this specific API request

Responses

Request samples

Payload

Content type

application/json

{"requestInfo": {"requestId": "ExamplePy-6911498-03",
"clientApiVersion": "1.0.0",
"clientName": "testing",
"clientVersion": "0.1"
}
}

Response samples

200
400

Content type

application/json

[{"tabId": "BgL28vkqsKCFGPkgtRh6",
"checkNumber": "012345",
"timestamp": "2021-02-15T17:32:28Z",
"creationTime": "2021-02-15T17:32:28Z",
"amountDetails": {"currencyCode": "USD",
"subtotal": "500",
"addedTax": "99",
"includedTax": "42",
"tip": "1000",
"discount": "12",
"fees": [{"name": "Service charge",
"amount": "1230000"
}
],
"donation": "500"
},
"orders": [{"orderId": "BfL19vkqsKCFFPkgtRh6",
"tabId": "stringstringstringst",
"subtotal": "5000000",
"items": [{"name": "Those Dam Fries",
"size": "Order",
"type": "Appetizer",
"category": "DRAFT_BEER",
"productId": "Bx4z_EXAMPLE-9Xf",
"quantity": "12.0",
"price": "500",
"addedTax": "99",
"includedTax": "42",
"discount": "12",
"isRefund": "false",
"costOfGoodsSold": 0,
"modifierEntries": [{"shortForm": "Extra Cheese",
"description": "Parmesan is a grate cheese",
"type": "CHEESE",
"usage": "ON_SIDE",
"size": "ORDER",
"upCharge": "500",
"discount": "100",
"totalCost": "500"
}
]
}
],
"timestamp": "2019-08-24T14:15:22Z"
}
],
"payments": [{"paymentType": "CREDIT_CARD",
"paymentAmount": "5000000",
"timestamp": "2021-02-15T17:32:28Z",
"processorFees": "80000"
}
],
"venueId": "BgL28vkqsC5hlPkg"
}
]

Gets a specific sale by its Arryved running tab id

Authorizations:

ApiKeyAuth

path Parameters

tabId

required

string

REQUIRED: The Arryved running tab id to get the sale data for

Responses

Response samples

200
400
404

Content type

application/json

{"tabId": "BgL28vkqsKCFGPkgtRh6",
"checkNumber": "012345",
"timestamp": "2021-02-15T17:32:28Z",
"creationTime": "2021-02-15T17:32:28Z",
"amountDetails": {"currencyCode": "USD",
"subtotal": "500",
"addedTax": "99",
"includedTax": "42",
"tip": "1000",
"discount": "12",
"fees": [{"name": "Service charge",
"amount": "1230000"
}
],
"donation": "500"
},
"orders": [{"orderId": "BfL19vkqsKCFFPkgtRh6",
"tabId": "stringstringstringst",
"subtotal": "5000000",
"items": [{"name": "Those Dam Fries",
"size": "Order",
"type": "Appetizer",
"category": "DRAFT_BEER",
"productId": "Bx4z_EXAMPLE-9Xf",
"quantity": "12.0",
"price": "500",
"addedTax": "99",
"includedTax": "42",
"discount": "12",
"isRefund": "false",
"costOfGoodsSold": 0,
"modifierEntries": [{"shortForm": "Extra Cheese",
"description": "Parmesan is a grate cheese",
"type": "CHEESE",
"usage": "ON_SIDE",
"size": "ORDER",
"upCharge": "500",
"discount": "100",
"totalCost": "500"
}
]
}
],
"timestamp": "2019-08-24T14:15:22Z"
}
],
"payments": [{"paymentType": "CREDIT_CARD",
"paymentAmount": "5000000",
"timestamp": "2021-02-15T17:32:28Z",
"processorFees": "80000"
}
],
"venueId": "BgL28vkqsC5hlPkg"
}

Authentication

Authenticate

Exchange an integration authentication token for a session token to be included in the X-API header

Authorizations:

ApiKeyAuth

Request Body schema: application/json

required	object (RequestInfoDto) Records basic details about this specific API request
required	object (AuthenticationDto) Provides the session token for a given company/auth request

Responses

Request samples

Payload

Content type

application/json

{"requestInfo": {"requestId": ":requestId123456",
"clientApiVersion": "1.0.0",
"clientName": "Arryved Mobile",
"clientVersion": "1.2.3"
},
"auth": {"companyId": ":companyid1",
"authToken": ":authTokenlOyuJ-qy07tmV7hsxxt67GDIrvJL4McexZb_qj6yaFaLInqCrzEdQP4Qplxl_I-gTmGwgCd3iWNA=="
}
}

Response samples

200
400

Content type

application/json

{"responseInfo": {"requestInfo": {"requestId": ":requestId123456",
"clientApiVersion": "1.0.0",
"clientName": "Arryved Mobile",
"clientVersion": "1.2.3"
},
"serverApiVersion": "1.0.0",
"serverVersion": "1.99.0"
},
"auth": {"companyId": ":companyid1",
"authToken": ":authTokenlOyuJ-qy07tmV7hsxxt67GDIrvJL4McexZb_qj6yaFaLInqCrzEdQP4Qplxl_I-gTmGwgCd3iWNA==",
"sessionToken": ":sessionToken-43ter-hkdfodr-0i6455wUquew09r90riewqrie09kqdofjiiepiqyuhgbtyty67456diW2e=="
}
}

Preauth

Request a temporary session authentication token to be included in the X-API header

Request Body schema: application/json

required	object (RequestInfoDto) Records basic details about this specific API request
required	object (PreauthDto) Holds the [networkId] and, on response, the associated preauth [token], which should be used in subsequent calls.

Responses

Request samples

Payload

Content type

application/json

{"requestInfo": {"requestId": ":requestId123456",
"clientApiVersion": "1.0.0",
"clientName": "Arryved Mobile",
"clientVersion": "1.2.3"
},
"preauth": {"networkId": ":networkId"
}
}

Response samples

200
400

Content type

application/json

{"responseInfo": {"requestInfo": {"requestId": ":requestId123456",
"clientApiVersion": "1.0.0",
"clientName": "Arryved Mobile",
"clientVersion": "1.2.3"
},
"serverApiVersion": "1.0.0",
"serverVersion": "1.99.0"
},
"preauth": {"networkId": ":networkId",
"token": ":authTokenmlOyuJ-qy07tmV7hsxxt67GDIrvJL4McexZb_qj6yaFaLInqCrzEdQP4Qplxl_I-gTmGwgCd3iWNA=="
}
}

Inventory

Supplies inventory-on-hand relative adjustment values

Authorizations:

ApiKeyAuth

Request Body schema: application/json

referenceId required	string [ 1 .. 30 ] characters REQUIRED: the third-party id for this adjustment request
idempotencyKey required	string [ 1 .. 36 ] characters REQUIRED: the idempotency key for this adjustment request (we suggest using a random UUID in websafe base64 format)
required	Array of objects (InventoryAdjustEntryDto) >= 0 items REQUIRED: the list of adjustments to make associated with the referenceId

Responses

Request samples

Payload

Content type

application/json

{"referenceId": "H389jshd882h4",
"idempotencyKey": "7cf21536-8de8-47ca-9373-116938889b31",
"entries": [{"sku": "01/1/123",
"adjustment": -1
}
]
}

Response samples

400
404

Content type

application/json

{ }

Order

List orders for a given location

Authorizations:

ApiKeyAuth

Request Body schema: application/json

	object Options for pagination and filtering
required	object (RequestInfoDto) Records basic details about this specific API request

Responses

Request samples

Payload

Content type

application/json

{"options": {"pagination": {"pageSize": 10,
"pageNumber": 1
},
"filters": [{"field": "locationId",
"type": "EQ",
"value": "BPfqyCS_"
}
]
},
"requestInfo": {"requestId": "ExamplePy-6911498-03",
"clientApiVersion": "1.0.0",
"clientName": "testing",
"clientVersion": "0.1"
}
}

Response samples

400
404

Content type

application/json

{ }

Product

List all products

Authorizations:

ApiKeyAuth

Responses

Response samples

200
400

Content type

application/json

[{"id": "Bx4z_EXAMPLE-9Xf",
"inventoryItemId": "BYlU_fgfKXEsycCr",
"name": "Big Belly Burger",
"state": "ACTIVE",
"sizes": [{"shortForm": "ORD",
"name": "Order",
"sku": "01/1/123ABClmnop",
"quantityAvailable": 0,
"state": "string"
}
],
"type": "Appetizer",
"category": "DRAFT_BEER",
"quantityBySize": true
}
]

Get a product by its identifier

Authorizations:

ApiKeyAuth

path Parameters

productId

required

string

Identifier of the product to get

Responses

Response samples

200
400
404

Content type

application/json

{"id": "Bx4z_EXAMPLE-9Xf",
"inventoryItemId": "BYlU_fgfKXEsycCr",
"name": "Big Belly Burger",
"state": "ACTIVE",
"sizes": [{"shortForm": "ORD",
"name": "Order",
"sku": "01/1/123ABClmnop",
"quantityAvailable": 0,
"state": "string"
}
],
"type": "Appetizer",
"category": "DRAFT_BEER",
"quantityBySize": true
}