inventory/addition/edit - Equotix One API

This edits an item addition on the Equotix One account.

Request

Body Params application/json

domain

string

required

The domain you are assigned to authenticate your Equotix One account.

api_key

string

required

The email address assigned to the user account in your Equotix One.

auth_timestamp

integer

required

The unix timestamp used to sign this API request.

auth_signature

string

required

The calculated signature for this API request.

item_addition_id

integer

required

The item addition ID to edit.

purchase_order_id

integer

required

The purchase order ID this item addition should associate to. Accepts 0.

currency

string

required

The currency code for this item addition.

currency_value

number

required

The currency value for this item addition. Accepts 0 for auto value.

comment

string

required

The comment for this item addition.

addition

array [object {5}]

required

The list of items for the item addition.

name

string

required

The item name.

item_id

integer

required

The item ID.

location_id

integer

required

The location ID to add quantity to.

quantity

integer

required

The quantity to add.

cost

number

optional

The item cost. Required if user account has permission to view item cost.

Example

{
  "domain": "string",
  "api_key": "string",
  "auth_timestamp": 0,
  "auth_signature": "string",
  "item_addition_id": 0,
  "purchase_order_id": 0,
  "currency": "string",
  "currency_value": 0,
  "comment": "string",
  "addition": [
    {
      "name": "string",
      "item_id": 0,
      "location_id": 0,
      "quantity": 0,
      "cost": 0
    }
  ]
}

Responses

🟢200Success

application/json

Body

error

array[string]

optional

Returns only if there is an error.

success

boolean

optional

Returns only if there is no error.

item_addition_id

integer

optional

The edited stock addition ID.

Example

{
  "error": [
    "string"
  ],
  "success": true,
  "item_addition_id": 0
}