inventory/purchase_order/edit

This edits a purchase order in 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.

purchase_order_id

integer

required

The purchase order ID to edit.

location_id

integer

required

The location ID for the purchase order.

supplier_id

integer

required

The supplier ID for the purchase order.

currency

string

required

The currency code for this purchase order.

currency_value

number

required

The currency value for this purchase order. Use 0 for auto value.

date_estimated_arrival

string

required

The date estimated arrival for this purchase order. In YYYY-MM-DD format. Empty string accepted.

date_received

string

required

The date estimated arrival for this purchase order. In YYYY-MM-DD format. Empty string accepted.

comment

string

required

The comment for this purchase order.

item

array [object {4}]

required

The list of items for the purchase order.

name

string

required

The item name.

item_id

integer

required

The item ID.

quantity

integer

required

The quantity to deduct.

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",
    "purchase_order_id": 0,
    "location_id": 0,
    "supplier_id": 0,
    "currency": "string",
    "currency_value": 0,
    "date_estimated_arrival": "string",
    "date_received": "string",
    "comment": "string",
    "item": [
        {
            "name": "string",
            "item_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.

purchase_order_id

integer

optional

The edited purchase order ID.

Example

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