Update Item Details for Multi SOI

This REST API is used to addition of Item Details of the sale order item (for Single Order x Multi SOI) by seller 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/oms/inflow/saleOrderItem/detail/add/bulk
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

{
  "saleOrderCode": "SO267",
  "saleOrderItemDetailDTOS": [
    {
      "saleOrderItemCode": "TEST_2_S-0",
      "itemDetails": [
        {
          "name": "itemSealId",
          "value": "12"
        },
        {
          "name": "Imei",
          "value": "adsadsddadsdadd"
        },
        {
          "name": "SerialNumber",
          "value": "adsadsddadsdadd"
        }
      ]
    },
    {
      "saleOrderItemCode": "TESTB-0",
      "itemDetails": [
        {
          "name": "itemSealId",
          "value": "12"
        },
        {
          "name": "Imei",
          "value": "adsadsddadsdadd"
        },
        {
          "name": "SerialNumber",
          "value": "adsadsddadsdadd"
        }
      ]
    }
  ]
}

Request Payload Details

LEVEL PARAMETER TYPE DESCRIPTION MANDATORY NOTES
1 saleOrderCode string Sale order code Yes -
2 saleOrderItemDetailDTOS list List of item codes Yes -
2.1 saleOrderItemCodes string Sale order item codes Yes -
2.2 itemDetails list List of item detail Yes -
2.2.1 name string item detail name Yes -
2.2.2 value string item detail value 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"
    }
  ],
  "addSaleOrderItemDetailResponses": [
    {
      "successful": true,
      "message": null,
      "errors": [
        
      ],
      "warnings": null,
      "saleOrderItemCode": "TEST_2_S-0"
    },
    {
      "successful": true,
      "message": null,
      "errors": [
        
      ],
      "warnings": null,
      "saleOrderItemCode": "TESTB-0"
    }
  ]
}

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 -
5 addSaleOrderItemDetailResponses list add sale order itemDetail responses -
5.1 successful true Request success status -
5.2 message string Response message -
5.3 errors list List of errors (if any) -
5.4 warnings list List of warnings (if any) -
5.5 saleOrderItemCode string Sale order item codes -

Error Codes

Refer Response Codes section to know about specific errors codes.

Unicommerce Website

Copyright © 2024 Unicommerce eSolutions Pvt. Ltd.