Sign in
Products

List products

Changed on

Product listing endpoint shown in the source document for active product filtering. Most product examples use /naproducts, the companion workbook does not include this path, and the endpoint returned HTTP 403 during a production smoke test. Prefer /naproducts unless the service provider confirms this endpoint is enabled for the target database.

get/products

Request

  • Base URL: https://api.myposconnect.com/api/v2
  • URL: https://api.myposconnect.com/api/v2/products
  • Auth: HTTP bearer

Query parameters

liPageSizeinteger

Number of records to return per page.

liPageinteger

Page number to return.

sFieldListstring

Comma-separated list of fields to return.

sSortKeystring

Sort column immediately followed by ASC or DESC, without whitespace.

filt_webproduct_boolboolean

Filter products by Web Product flag.

filt_active_boolboolean

Filter products by Active flag.

filt_stylecode_strstring

Filter products by style code.

Response

Product list returned.

customSortRowNumberinteger

One-based record position in a list response.

liTotalCountinteger

Total records matching the request, repeated on list items.

productIdstring uuid
productCodestring
shortDescriptionstring
longDescriptionstring
buttonTextstring

Casing returned by the single-product sample.

buttontextstring

Casing returned by the style-list sample.

brandstring
fullDescriptionstring
barcodestring
productSizestring
styleCodestring
styleDescriptionstring
productColourstring
productType'A' | 'B' | 'E' | 'H' | 'K' | 'M' | 'Q' | 'S' | 'U' | 'W' | 'Z'

Product type code documented by the sample-call spreadsheet.

rewardPointsinteger

Additional reward points associated with the product.

allowDiscountsboolean
productNotesstring
stockControlstring
activeboolean
binLocationstring
imageFilenamestring
productClass1string nullable
productClass2string nullable
productClass3string nullable
productClass4string nullable
supplierNamestring
productTitleunknown
productWeightunknown
webHoldbacknumber double
webOrdersboolean
lastModifiedstring nullable

Timestamp returned without a UTC offset, or null.

unpackedFromunknown
packedIntounknown
otherProductClassesstring[]
cC_001string nullable
cC_002string nullable
cC_003string nullable
cC_004string nullable
cC_005string nullable
cC_006string nullable
cC_007string nullable
cC_008string nullable
cC_009string nullable
cC_010string nullable
lastEditUserstring
creationUserstring
lastEditDevicestring
creationDevicestring
lastEditDatestring

Timestamp returned without a UTC offset in the supplied samples.

creationDatestring

Timestamp returned without a UTC offset in the supplied samples.

Example response

[
  {
    "customSortRowNumber": 1,
    "liTotalCount": 2,
    "productId": "00000000-0000-4000-8000-000000000001",
    "productCode": "STYLE02",
    "longDescription": "STYLE 02",
    "productSize": "XS",
    "styleCode": "STY001",
    "productColour": "GREEN",
    "active": true
  }
]

Changes

  • 25ec65796a4fRevision changes
    • info

      endpoint deprecated

  • 3f7cebe5efd8Revision changes
    • 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