You are using an unsupported browser. Please update your browser to the latest version on or before July 31, 2020.
close
You are viewing the article in preview mode. It is not live at the moment.
Home > MYPOS Connect > API & Integration Manager > API Stock & Inventory > Classifications & ProductsClassifications API
Classifications & ProductsClassifications API
print icon
Classifications API + ProductsClassifications API
 

There are three methods available for classifications :

  1. List all classifications
  2. Return full detail on a single classification
  3. List all ProductsClassifications

Note: A product can have one or many classes

List all classifications

End Point: https://api.myposconnect.com/api/v2/classifications

Verb: GET

Example Call: https://api.myposconnect.com/api/v2/classifications?lipage=1&lipagesize=999999

Return Codes: 200 for success, with the body containing the JSON for the classifications. For other possible (more general) return codes please see API Build Basics

Important: This call returns a restricted flat view of the classifications. The JSON objects in the array are not full JSON objects as shown in the appendices of this document. If some of the deeper information is required then you will need to use the method for getting a single object. There are several query string arguments that can be used with this call as follows (you may need to URL encode your argument values).

Return full detail on a single class by Class Identifier

End Point: https://api.myposconnect.com/api/v2/classifications/{identifier}

Verb: GET

Example Call: https://api.myposconnect.com/api/v2/classifications/67fcefb2-fcaf-4424-98fa-7768e7025825

Return Codes: 200 for success, with the body containing the JSON for the class. For other possible (more general) return codes please see API Build Basics

Important: This call returns a view of a single class and related fields including related products and custom fields tailored for individual MYPOS clients. 

List all ProductsClassifications

End Point: https://api.myposconnect.com/api/v2/products/classifications

Verb: GET

Example Call: https://api.myposconnect.com/api/v2/products/classifications?lipagesize=999999&lipage=1

Return Codes: 200 for success, with the body containing the JSON for the product classifications. For other possible (more general) return codes please see API Build Basics

Important: This call returns a restricted flat view of the products classifications. The JSON objects in the array are not full JSON objects as shown in the appendices of this document. If some of the deeper information is required then you will need to use the method for getting a single object. There are several query string arguments that can be used with this call as follows (you may need to URL encode your argument values).

Troubleshooting Ideas

As with all API connections, you will need to have acquired a bearer token and the user that acquired the token will need to be assigned access permission to this table. If you are not receiving any results send the full endpoint together with any filters and the API user to us from a valid email address and we can advise if permissions have been authorised. You might be able to see data with one table and not another if specific permissions are not applied.

Feedback
0 out of 0 found this helpful

scroll to top icon