Update an item

PUT 
/api/v3/item/:item_id

This allows you to update an existing product. When updating a product, you can specify the pricing for multiple currencies if desired.

Request

application/json

Body

name string

Item name

description string

Description

enabled boolean

Enabled/disabled

accounting_sku string

Accounting SKU

accounting_account_income string

Accounting Income Account

external_key string

External key value

units string

Units string

custom_1 string

Custom field value #1

custom_2 string

Custom field value #2

custom_3 string

Custom field value #3

Responses

202

Object was updated successfully

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable

response

object

id integer

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": {
    "id": 0
  }
}

Example 1

{
  "code": 201,
  "status": "OK",
  "message": "",
  "details": {},
  "response": {
    "id": 1234
  }
}

400

Bad request

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response boolean

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 400,
  "status": "Error",
  "message": "Missing or invalid parameter.",
  "details": {},
  "response": false
}

401

Authentication error

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response boolean

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 401,
  "status": "Error",
  "message": "Invalid or incorrect authorization [Missing (basic) authorization header.]",
  "details": {},
  "response": false
}

Loading...