Products

Get general details for a single product

Changed on
get/naproducts/{ProductCode}

Request

  • Base URL: https://api.myposconnect.com/api/v2
  • URL: https://api.myposconnect.com/api/v2/naproducts/{ProductCode}
  • Auth: HTTP bearer

Path parameters

ProductCodestring required

Query parameters

sFieldListstring

Comma-separated list of fields to return.

Response

Product 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

{
  "productId": "00000000-0000-4000-8000-000000000002",
  "productCode": "SKU-EXAMPLE-001",
  "shortDescription": "Example Lavender Soap",
  "longDescription": "Example Lavender Soap, 500 mL",
  "buttonText": "Example Lavender Soap",
  "brand": "Example Brand",
  "barcode": "BARCODE-EXAMPLE-001",
  "styleCode": "STYLE-EXAMPLE-001",
  "productType": "S",
  "rewardPoints": 0,
  "allowDiscounts": true,
  "stockControl": "Y",
  "active": true,
  "productClass1": "Example Class",
  "productClass2": "Example Subclass",
  "webHoldback": 0,
  "webOrders": false,
  "otherProductClasses": [
    "Environmentally Friendly",
    "Natural"
  ],
  "lastEditDate": "2020-08-25T13:02:16.967",
  "creationDate": "2020-08-25T13:02:16.96"
}

Changes

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

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • 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 optional property became read-only for the status

    • info

      the response optional property became read-only for the status

  • 6bf304ac4f2cRevision changes
    • info

      api operation id productsRetrieve was added