Update Sale Order
This REST API is used to update sale order details in Uniware, such as billing address, shipping address, etc.
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/oms/saleOrder/edit |
Request Type: | POST |
Level: | Tenant |
Scheme: | HTTPS |
Header (Content-Type): | application/json |
Header (Authorization): | bearer {access-token}, Eg.: bearer b30f3aea-7978-49bb-9ea7-33eddfc80afa |
Request Payload
{
"saleOrderAddress": {
"saleOrderCode": "string",
"addresses": [
{
"id": "string",
"name": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"country": "string",
"pincode": "string",
"phone": "string",
"email": "string"
}
],
"billingAddress": {
"referenceId": "string"
},
"shippingAddress": {
"referenceId": "string"
},
"saleOrderAddressItems": [
{
"saleOrderItemCode": "string",
"shippingAddress": {
"referenceId": "string"
}
}
]
}
}
Request Payload Details
LEVEL | PARAMETER | TYPE | DESCRIPTION | MANDATORY | NOTES |
---|---|---|---|---|---|
1 | saleOrderAddress | object | Sale order address details | Yes | |
1.1 | saleOrderCode | string | Sale order code | Yes | |
1.2 | addresses | list | Address information | Yes | - |
1.2.1 | id | string | ID | Yes | |
1.2.2 | name | string | Buyer name | Yes | Max. chars: 100 |
1.2.3 | addressLine1 | string | Precise address of receiver | Yes | Max. chars: 500 |
1.2.4 | addressLine2 | string | Additional address information | No | - |
1.2.5 | city | string | City name | Yes | Eg: Surat, Max. chars: 100 |
1.2.6 | state | string | State name | Yes | Eg: Gujrat, Max. chars: 45 |
1.2.7 | country | string | Country name | No | Eg: India |
1.2.8 | pincode | string | Area pincode (min. 6 digits) | No | Eg: 395006, Max. chars: 45 |
1.2.9 | phone | string | Contact no. | Yes | Max. chars: 50 |
1.2.10 | string | Email address | No | Max. chars: 100 | |
1.3 | billingAddress | object | Billing address details | No | |
1.3.1 | referenceId | string | Billing reference id | Yes | |
1.4 | shippingAddress | object | Shipping address details | Yes | - |
1.4.1 | referenceId | string | Shipping reference id | Yes | |
1.5 | saleOrderAddressItems | list | Sale order address details | No | |
1.5.1 | saleOrderItemCode | string | Sale order item code | Yes | |
1.5.2 | shippingAddress | object | Shipping address details | Yes | - |
1.5.2.1 | referenceId | string | Shipping reference id | Yes |
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 | Warning 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.