CHchannable
stock_updates

Get Stock Updates

Changed on

This endpoint retrieves all offers for a given project of your company, sorted from most recent to oldest. Offers are the product updates that you posted.

These are found under "Orders" > "Product updates" in the Channable tool. Optionally, you can pass query parameters to customize the query and response content.

Example usage

Suppose the following scenario for a given project of yours:

  • The project contains the offers o1, o2, o3, and o4 (from oldest to most recent)
  • o1 and o4 are searchable by the term t
  • o3 is searchable by the term tE
Request parametersResponse
none{"offers": [o4, o3, o2, o1], "total": 4}
?limit=2{"offers": [o4, o3], "total": 2}
?offset=4{"offers": [], "total": 0}
?offset=1{"offers": [o3, o2, o1], "total": 3}
?offset=1&limit=1{"offers": [o3], "total": 1}
?offset=1&limit=2{"offers": [o3, o2], "total": 2}
?search=t{"offers": [o4, o1], "total": 2}
?search=tE{"offers": [o3], "total": 1}
?start_date=2018-01-01{"offers": [o4, o3, o2], "total": 3}
?start_date=2018-01-01&end_date=2018-02-28{"offers": [o3, o2], "total": 2}
?last_modified_after=2018-02-29{"offers": [o4], "total": 1}
get/v1/companies/{company_id}/projects/{project_id}/offers

Request

  • Base URL
    https://api.channable.com (the document declares no server; this is the origin it was published from)
  • Auth
    none declared

Path parameters

company_idinteger required
project_idinteger required

Query parameters

searchstring nullable

Any text based search query

string date
OR
string date-time
string date
OR
string date-time
string date
OR
string date-time
string date
OR
string date-time
limitinteger

Max number of results in a single page.

offsetinteger

Filter results starting from this offset.

Response

Successful Response

totalinteger required

Example response

{
  "offers": [
    {
      "client_id": "2026523",
      "created": "2022-04-19T07:18:44.436934+00:00",
      "gtin": "1234567890123",
      "id": 2251,
      "modified": "2022-04-19T07:18:44.436934+00:00",
      "price": 10.5,
      "project_id": -1,
      "stock": 0,
      "stock_tracking": true,
      "title": "test title"
    }
  ],
  "total": 1
}

Changes

  • a58f20354a07Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      the /// response's property pattern ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ was added for the status

  • 154002d0663aRevision changes
    • breaking

      the response property // became optional for the status

    • breaking

      response property offers/items/availability list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property offers/items/gtin list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property offers/items/id list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property offers/items/price list-of-types was widened by adding types null and string to media type application/json of response 200

    • breaking

      response property offers/items/stock list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property offers/items/title list-of-types was widened by adding types null to media type application/json of response 200

    • info

      query request parameter end_date list-of-types was widened by adding types null

    • info

      query request parameter last_modified_after list-of-types was widened by adding types null

    • info

      query request parameter last_modified_before list-of-types was widened by adding types null

    • info

      query request parameter search list-of-types was widened by adding types null

    • info

      query request parameter start_date list-of-types was widened by adding types null

    • info

      for the query request parameter end_date, the type was generalized from string to no type, and format from date to no format

    • info

      for the query request parameter last_modified_after, the type was generalized from string to no type, and format from date to no format

    • info

      for the query request parameter last_modified_before, the type was generalized from string to no type, and format from date to no format

    • info

      for the query request parameter search, the type was generalized from string to no type

    • info

      for the query request parameter start_date, the type was generalized from string to no type, and format from date to no format