Update Item Inventory per Ship Node

v1.0.0

This API will update the inventory for an item across one or more fulfillment centers, known as ship nodes.

Input

{
  "type": "object",
  "properties": {
    "WM_CONSUMER.CHANNEL.TYPE": {
      "type": "string"
    },
    "WM_QOS.CORRELATION_ID": {
      "type": "string"
    },
    "WM_SEC.ACCESS_TOKEN": {
      "type": "string"
    },
    "WM_SVC.NAME": {
      "type": "string"
    },
    "inventories": {
      "type": "object",
      "required": [
        "nodes"
      ],
      "properties": {
        "nodes": {
          "type": "array",
          "items": {
            "type": "object",
            "required": [
              "inputQty",
              "shipNode"
            ],
            "properties": {
              "inputQty": {
                "type": "object",
                "description": "Quantity that has been ordered by the customers but not yet shipped",
                "required": [
                  "amount",
                  "unit"
                ],
                "properties": {
                  "amount": {
                    "type": "number",
                    "description": "Inventory Count"
                  },
                  "unit": {
                    "type": "string",
                    "description": "The unit of measurement. Example: 'EACH'",
                    "enum": [
                      "EACH"
                    ]
                  }
                }
              },
              "shipNode": {
                "type": "string",
                "description": "ShipNode Id of the ship node for which the inventory is requested"
              }
            }
          }
        }
      }
    },
    "sku": {
      "type": "string"
    }
  },
  "required": [
    "WM_QOS.CORRELATION_ID",
    "WM_SEC.ACCESS_TOKEN",
    "WM_SVC.NAME",
    "inventories",
    "sku"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "properties": {
    "nodes": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "errors": {
            "type": "array",
            "description": "Node Update Error description.",
            "items": {
              "type": "object",
              "required": [
                "code"
              ],
              "properties": {
                "category": {
                  "type": "string",
                  "enum": [
                    "APPLICATION",
                    "SYSTEM",
                    "REQUEST",
                    "DATA"
                  ]
                },
                "causes": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "code": {
                        "type": "string"
                      },
                      "description": {
                        "type": "string"
                      },
                      "field": {
                        "type": "string"
                      },
                      "type": {
                        "type": "string"
                      }
                    }
                  }
                },
                "code": {
                  "type": "string"
                },
                "description": {
                  "type": "string"
                },
                "errorIdentifiers": {
                  "type": "object"
                },
                "field": {
                  "type": "string"
                },
                "info": {
                  "type": "string"
                },
                "severity": {
                  "type": "string",
                  "enum": [
                    "INFO",
                    "WARN",
                    "ERROR"
                  ]
                }
              }
            }
          },
          "shipNode": {
            "type": "string",
            "description": "ShipNode Id of the ship node for which the inventory is requested"
          },
          "status": {
            "type": "string",
            "description": "Node Update status. Example: 'Success'"
          }
        }
      }
    },
    "sku": {
      "type": "string",
      "description": "An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item."
    }
  }
}