Create or Update Vendor Catalog
This REST API is used to create new or modify existing item types for a vendor in Uniware.
Tip
It is recommended to check out Notes for the reader. You might find this helpful as it contains Guidelines for using API references and Terminologies used here.
Basic Information
NAME | DETAILS |
---|---|
Endpoint: | /services/rest/v1/purchase/vendorItemType/createOrEdit |
Request Type: | POST |
Level: | Facility |
Scheme: | HTTPS |
Header (Content-Type): | application/json |
Header (Authorization): | bearer {access-token}, Eg.: bearer b30f3aea-7978-49bb-9ea7-33eddfc80afa |
Header (Facility): | facility code as in Uniware (refer FAQs) |
Request Payload
{
"vendorItemType": {
"vendorCode": "ABC",
"itemTypeSkuCode": "UCSKU_Yellow_XL",
"vendorSkuCode": "VSKU_Yellow_XL",
"inventory": 100,
"unitPrice": 500,
"priority": 1,
"enabled": true,
"customFieldValues": [
{
"name": "string",
"value": "string"
}
]
}
}
Request Payload Details
LEVEL | PARAMETER | TYPE | DESCRIPTION | MANDATORY | NOTES |
---|---|---|---|---|---|
1 | vendorItemType | object | Vendor item type details | Yes | - |
1.1 | vendorCode | string | Vendor code | Yes | - |
1.2 | itemTypeSkuCode | string | Item type SKU code | Yes | - |
1.3 | vendorSkuCode | string | Vendor SKU code | No | - |
1.4 | inventory | integer | Available quantity | No | - |
1.5 | unitPrice | number | Unit price | Yes | - |
1.6 | priority | integer | Order fullfillment priority | No | Use a sequential numbering as 1..2…3 to define the order for mapping items with different vendors. |
1.7 | enabled | boolean | use “true” if enabled else use “false” | No | - |
1.8 | customFieldValues | list | Custom field details | No | - |
1.8.1 | name | string | Custom field name | Yes | - |
1.8.2 | value | string | Custom field value | No | - |
Response Payload
{
"successful": true,
"message": "string",
"errors": [
{
"code": 0,
"fieldName": "string",
"description": "string",
"message": "string",
"errorParams": {
"additionalProp1": {},
"additionalProp2": {},
"additionalProp3": {}
}
}
],
"warnings": [
{
"code": 0,
"message": "string",
"description": "string"
}
]
}
Response Payload Details
LEVEL | PARAMETER | TYPE | DESCRIPTION | NOTES |
---|---|---|---|---|
1 | successful | true | Request success status | - |
2 | message | string | Response message | - |
3 | errors | list | List of errors (if any) | - |
3.1 | code | number | Error code | - |
3.2 | fieldName | string | Field with error | - |
3.3 | description | string | Error description | - |
3.4 | message | string | Error message | - |
3.5 | errorParams | object | Parameters with error | - |
3.5.1 | additionalProp1 | object | Parameter 1 with error | - |
3.5.2 | additionalProp2 | object | Parameter 2 with error | - |
3.5.3 | additionalProp3 | object | Parameter 3 with error | - |
4 | warnings | list | List of warnings (if any) | - |
4.1 | code | number | Warning code | - |
4.2 | message | string | Warning message | - |
4.3 | description | string | Warning description | - |
Error Codes
Refer Response Codes section to know about specific errors codes.