Products

List store product price, cost, quantity and tax changes

Changed on

Returns price, cost, quantity available and tax for all products modified after the specified UTC date/time. The documented path uses two ~ separators.

get/productspq/~{StoreCode}~{LastEditDate}

Request

  • Base URL: https://api.myposconnect.com/api/v2
  • URL: https://api.myposconnect.com/api/v2/productspq/~{StoreCode}~{LastEditDate}
  • Auth: HTTP bearer

Path parameters

StoreCodestring required
LastEditDatestring required

UTC date/time in the companion workbook's 24-hour YYYY-MM-DD HH:MM:SS.fff format. The client percent-encodes the space when placing the value in the URL path.

Query parameters

liPageSizeinteger

Number of records to return per page.

liPageinteger

Page number to return.

Response

Store product data returned.

customSortRowNumberinteger
liTotalCountinteger
storeCodestring
productCodestring
quantitynumber double
webPricenumber double

Backward-compatible alias for price01.

price01number double
price02number double
price03number double
price04number double
price05number double
price06number double
price07number double
price08number double
price09number double
price10number double
taxGroupstring
saleEnabled1boolean
salePrice1number double nullable
saleStartDate1string nullable
saleEndDate1string nullable
saleEnabled2boolean
salePrice2number double nullable
saleStartDate2string nullable
saleEndDate2string nullable
webHoldbacknumber double

Example response

[
  {
    "customSortRowNumber": 1,
    "liTotalCount": 1,
    "storeCode": "STORE-001",
    "productCode": "SKU-EXAMPLE-001",
    "quantity": 0,
    "webPrice": 20,
    "price01": 20,
    "price02": 0,
    "price03": 0,
    "price04": 0,
    "price05": 0,
    "price06": 0,
    "price07": 0,
    "price08": 0,
    "price09": 0,
    "price10": 0,
    "taxGroup": "Sales Tax",
    "saleEnabled1": false,
    "salePrice1": null,
    "saleStartDate1": null,
    "saleEndDate1": null,
    "saleEnabled2": false,
    "salePrice2": null,
    "saleStartDate2": null,
    "saleEndDate2": null,
    "webHoldback": 0
  }
]

Changes

    • breaking

      added the pattern ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}\.\d{3}$ to the path request parameter LastEditDate

    • breaking

      the response's body type changed from no type to array for status

    • breaking

      the response's body type changed from object to no type for status

    • breaking

      the response's body type changed from object to no type for status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      removed subschema #1 subschema #2 from the response body oneOf list for the response status