The DELETE /items/{id} call allows your platform to delete an item. Items describe an item or service for sale. For standardized merchandise, an item could be a stock keeping unit (SKU).
SecurityappIdAuth and appTokenAuth
Request
path Parameters
id
required
string [ 1 .. 255 ] characters
ID of the order, generated by WePay when the order is created.
header Parameters
Api-Version
required
string
Example: 3.0
Unique-Key
string
Responses
200
Response Schema: application/json
id
required
string or null
ID of the order, generated by WePay when the order is created.
path
required
string
The HTTP path of the resource. The path can be used to retrieve details about the resource and perform actions on it.
required
object
Details the owner resource and owner path.
resource
required
string
Helps organize information by identifying the resource type of the object data.
Value:
Description
items
create_time
required
integer <int64> >= 0
The time (in UNIX) when the payment was created.
product_name
required
string <= 255 characters
The name of the product or service your user signed up for on your platform.
state
required
string
State of the item. Possible values: active, deleted.
Enum:
Description
active
The item is active.
deleted
The item is deleted.
account_id
string or null
Merchant's account id associated with the item.
api_version
string
currency
string or null
Enum:
Description
USD
United States Dollar
CAD
Canadian Dollar
… 1 more
description
string or null <= 2047 characters
Description of the product or service.
photos
Array of strings or null
URL for photo images.
price
integer or null
Price of the item or service.
product_code
string or null <= 255 characters
SKU etc.
object or null
Any product details your platform chooses to attach to this resource. The product detail data must be key-value pairs. For example, a pair of black running shoes could have "category1":"Clothing, Shoes, and Accessories", "category2":"Women's shoes", "color":"black".
reference_number
string or null [ 1 .. 255 ] characters
A reference number your platform assigns to an Item.