Product Management API (1.0)
The Product Management API allows you to search for products
Each request is authorized using username and password fields passed either as query parameters (for GET/POST operations) or part of the application/x-www-form-urlencoded body (for POST operations).
Each response contains a response_status field containing the following error codes.
| Code | Severity | Description |
|---|---|---|
| 10001 | SUCCESS | |
| 30001 | ERROR | Authentication failed |
| 31000 | ERROR | API not enabled on your site |
| 40004 | WARNING | Product ID Not Found |
| 50002 | ERROR | No conditions specified |
| 50003 | ERROR | Condition N 'field' is missing |
| 50003 | ERROR | Condition N 'condition' is missing |
| 50003 | ERROR | date1 is invalid |
| 50003 | ERROR | date2 is invalid |
| 50004 | ERROR | Invalid limit or offset |
| 50005 | ERROR | Invalid request parameters |
Product Search
Retrieve a list of products based upon your search parameters.
The maximum number of rows returned is 100. Use the returned "total" value to determine if you need to paginate using the offset parameter.
You can specify multiple conditions in which case the conditions will be join with a logical 'AND'.
To use multiple conditions you will need to pass the parameters using the multi condition parameter format:
conditions[n][parameter name]where n starts at 1 and "parameter name" is the name of the parameter as below.
Request Body schema: application/x-www-form-urlencoded
| field required | integer The Field the condition is tested against. Values
|
| condition required | integer The logical test to use. Values
|
| date1 | string The date to test against (Required when field is a date). |
| date2 | string The end date to test against (Required when field is a date and condition is 7: Between). |
| string | string The string to test against (Required when field is Product Code or Name). |
| limit | integer [ 0 .. 100 ] Default: 100 Limit the number of results returned. The maximum limit is 100 |
| offset | integer Default: 0 Offset of the results to allow pagination |
| sortby | integer Default: 6 What field to sort the results by
|
Responses
Response Schema: application/json
object (ResponseStatus) | |
Array of objects (Product) An array of product objects | |
| total | integer The total number of products found |
Request samples
- Payload
field=5&condition=4&date1=2018-02-01T00%3A00%3A00
Response samples
- 200
{- "response_status": {
- "code": 0,
- "severity": "SUCCESS",
- "description": ""
}, - "products": [
- {
- "product_id": "19658",
- "product_code": "2000",
- "product_name": "Ultra Cotton 100% Cotton T Shirt",
- "supplier": "Sanmar",
- "brand": "Gildan",
- "is_active": true,
- "categories": [
- {
- "id": 234453,
- "name": "Shirts",
- "ancestors": {
- "id": 234234,
- "name": "Apparel",
- "ancestors": { }
}
}
], - "date_modified": "2018-12-05T00:00:00"
}, - {
- "product_id": "456456",
- "product_code": "2000B",
- "product_name": "Heavy Ultra Cotton 100% Cotton T Shirt",
- "supplier": "Sanmar",
- "brand": "Gildan",
- "is_active": true,
- "categories": [
- {
- "id": 234453,
- "name": "Shirts",
- "ancestors": {
- "id": 234234,
- "name": "Apparel",
- "ancestors": { }
}
}
], - "date_modified": "2018-12-05T00:00:00"
}
], - "total": 2
}Get Product
Get a single product or a list of products
query Parameters
| id | number Example: id=234 the id of the product |
| ids | string Example: ids=1234567,124234,23434 a comma separated list of product ids (max 100) |
Responses
Response Schema: application/json
required | object (ResponseStatus) |
object (ProductDetailed) | |
Array of objects (ProductDetailed) An array of product details when the ids parameter is used |
Response samples
- 200
{- "response_status": {
- "code": 0,
- "severity": "SUCCESS",
- "description": "string"
}, - "product": {
- "product_id": "19658",
- "product_code": "2000",
- "product_name": "Ultra Cotton 100% Cotton T Shirt",
- "supplier": "Sanmar",
- "brand": "Gildan",
- "is_active": true,
- "categories": [
- {
- "id": 6345,
- "name": "Apparel",
- "ancestors": { }
}
], - "date_modified": "2018-12-05T00:00:00",
- "sizes": [
- {
- "id": 6345,
- "name": "Medium",
- "code": "M",
- "sub_options": [
- {
- "id": 743546,
- "name": "Long",
- "code": "L"
}
]
}
], - "colors": [
- {
- "id": 5675,
- "name": "Black"
}
], - "skus": [
- {
- "size_id": 6345,
- "subsize_id": 743546,
- "color_id": 5675,
- "sku": "C44A12",
- "gtin": "0034534550345",
- "dn_sku_id": "123423513",
- "price": 5.5,
- "cost": 3.5
}
]
}
}IMPORTANT NOTICE: The following notice pertains to Altacolor LLC's responsibilities and the user's rights as regards API use and may affect a user's legal rights. Read carefully, as use of any product or technological facility provided by Altacolor LLC binds the user to these terms:
- Altacolor LLC is a limited-liability company formed in the United States, with a nexus in the state of Texas.
- Altacolor LLC does not provide support for API functions and does not guarantee or warrant performance, correctness, or fitness for a specific purpose of this software. Use of these API functions are SOLELY at the risk of the user. Use of the provided API is acknowledgement by the user of the foregoing and the user assumes all risk, loss or any other consequence of using these functions in whole or in part and further specifically indemnifies Altacolor LLC, its principals, employees, subsidiaries, affiliates, assigns, agents or representatives from any harm that may arise for the use of or access to the supplied API(s).
- Altacolor LLC makes no representations regarding the security or lack thereof of data in whole or part shared using the API or as stored on Altacolor LLC's servers whether onsite or remotely. The user shall at all times maintain appropriate data security and breach insurance that indemnifies Altacolor LLC, its principals, employees, subsidiaries, affiliates, assigns, agents or representatives against loss whether material or otherwise and further includes any axillary fees and costs such as legal fees, consulting fees, government fees, technology fees or any other sundry costs and fees that may be associated with legal action any action contemplated by the user or a third party actor.
- If any provision set forth herein is held to be illegal, invalid, or unenforceable under present or future laws effective during the term of this agreement, such provision is fully severable, and this agreement must be construed and enforced as if such illegal, invalid, or unenforceable provision never comprised a part of this agreement; and the remaining provisions of this agreement remain in full force and effect and may not be affected by the illegal, invalid, or unenforceable provision or its severance from this agreement.