Stock

Sell more than just activities

PreviousProducts NextAvailability

Was this helpful?

List Product Stock

get

This API returns all the stock items.

Authorizations

Query parameters

stock_idstring[]Optional

[FILTER] on stock_id.

stock_product_idstring[]Optional

[FILTER] on stock_product_id.

include_disabledbooleanOptional

[FILTER] Include disabled / closed (stock_active:false) entries.

Default: falseExample: true

stock_modifiedstring · date-timeOptional

[FILTER] Only show entries modified after the given date.

Header parameters

If-Modified-SincestringOptional

[CACHE] The If-Modified-Since request HTTP header makes the request conditional: the server will send back the requested resource, with a 200 status, only if it has been modified after the given date.

If the resource has not been modified since, the response will be a 304 without any body; the Last-Modified response header of a previous request will contain the date of last modification.

Note that if a single resource has changed, all records matching your request will be returned, not just those changed after the given date. This provides you with an efficient caching method.

Example: Wed, 21 Jan 2022 07:28:00 GMT

Responses

200

Product Stock Response

application/json

400

Invalid Request The HyperText Transfer Protocol (HTTP) 400 Bad Request response status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).

application/json

401

Authentication Failed The access token provided is expired, revoked, malformed, or invalid for other reasons. The resource SHOULD respond with the HTTP 401 (Unauthorized) status code. The client MAY request a new access token and retry the protected resource request.

application/json

403

Forbidden The request requires higher privileges than provided by the access token. The resource server SHOULD respond with the HTTP 403 (Forbidden) status code and MAY include the `scope` attribute with the scope necessary to access the protected resource.

application/json

405

Method Not Allowed The HyperText Transfer Protocol (HTTP) 405 Method Not Allowed response status code indicates that the request method is known by the server but is not supported by the target resource. A request method is not supported for the requested resource; for example, a GET request on a form that requires data to be presented via POST, or a PUT request on a read-only resource.

application/json

406

Not Acceptable The HyperText Transfer Protocol (HTTP) 406 Not Acceptable client error response code indicates that the server cannot produce a response matching the list of acceptable values defined in the request's proactive content negotiation headers, and that the server is unwilling to supply a default representation.

application/json

422

Unprocessable Entity The HyperText Transfer Protocol (HTTP) 422 Unprocessable Entity response status code indicates that the server understands the content type of the request entity, and the syntax of the request entity is correct, but it was unable to process the contained instructions.

application/json

429

Too Many Requests The HTTP 429 Too Many Requests response status code indicates the user has sent too many requests in a given amount of time ("rate limiting").

application/json

500

Internal Server Error The HyperText Transfer Protocol (HTTP) 500 Internal Server Error response code indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

application/json

501

Not Implemented The HyperText Transfer Protocol (HTTP) 501 Not Implemented server error response code means that the server does not support the functionality required to fulfill the request. The server either does not recognize the request method, or it lacks the ability to fulfil the request. Usually this implies future availability (e.g., a new feature of a web-service API).

application/json

502

Bad Gateway The HyperText Transfer Protocol (HTTP) 502 Bad Gateway server error response code indicates that the server, while acting as a gateway or proxy, received an invalid response from the upstream server. The HTTP 502 Bad Gateway error is exclusively returned in case of problems during communication with the supplier or third-party system.

application/json

503

Service Unavailable The HyperText Transfer Protocol (HTTP) 503 Service Unavailable server error response code indicates that the server is not ready to handle the request. The HTTP 503 Service Unavailable error is exclusively returned in case of problems during internal communication.

application/json

504

Gateway Timeout The HyperText Transfer Protocol (HTTP) 504 Gateway Timeout server error response code indicates that the server, while acting as a gateway or proxy, did not get a response in time from the upstream server that it needed in order to complete the request. The HTTP 504 Gateway Timeout error is exclusively returned in case of problems during communication with the supplier or third-party system.

application/json

get

GET /v3.8/distributor/products/stock HTTP/1.1
Host: staging-distributor-api.prioticket.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "api_version": "3.8.0",
  "data": {
    "kind": "location",
    "total_items": 10,
    "items": [
      {
        "stock_id": "20191026090010006526",
        "stock_active": true,
        "stock_label": "Morning",
        "stock_product_id": "3532",
        "stock_spots": {
          "stock_items_total": 100,
          "stock_items_reserved": 15,
          "stock_items_booked": 10,
          "stock_items_available": 75
        },
        "stock_created": "2025-06-17T07:47:05.353Z",
        "stock_created_name": "Demo Cashier",
        "stock_created_email": "cashier@prioticket.com",
        "stock_modified": "2025-06-17T07:47:05.353Z",
        "stock_modified_name": "Demo Cashier",
        "stock_modified_email": "cashier@prioticket.com"
      }
    ]
  }
}

Update Product Stock

put

This API allows to update the stock for merchandise items.

Authorizations

Path parameters

stock_idstringRequired

Identifier of the stock that is updated.

Example: 84534534

Query parameters

stock_items_availablestringRequired

Updated stock quantity.

Example: 50

Responses

200

Product Stock Response

application/json

400

application/json

401

application/json

403

application/json

405

application/json

406

application/json

422

application/json

429

Too Many Requests The HTTP 429 Too Many Requests response status code indicates the user has sent too many requests in a given amount of time ("rate limiting").

application/json

500

application/json

501

application/json

502

application/json

503

application/json

504

application/json

put

PUT /v3.8/distributor/products/stock/{stock_id} HTTP/1.1
Host: staging-distributor-api.prioticket.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "api_version": "3.8.0",
  "data": {
    "kind": "location",
    "total_items": 10,
    "items": [
      {
        "stock_id": "20191026090010006526",
        "stock_active": true,
        "stock_label": "Morning",
        "stock_product_id": "3532",
        "stock_spots": {
          "stock_items_total": 100,
          "stock_items_reserved": 15,
          "stock_items_booked": 10,
          "stock_items_available": 75
        },
        "stock_created": "2025-06-17T07:47:05.353Z",
        "stock_created_name": "Demo Cashier",
        "stock_created_email": "cashier@prioticket.com",
        "stock_modified": "2025-06-17T07:47:05.353Z",
        "stock_modified_name": "Demo Cashier",
        "stock_modified_email": "cashier@prioticket.com"
      }
    ]
  }
}