WePay logo
      Nothing Found

Update an item

post/items/{id}

The POST /items/{id} call allows your platform to update and add custom data 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
Content-Type
required
stringapplication/json
Example: application/json
Unique-Key
string
Request Body schema: application/json
account_id
string [ 1 .. 255 ] characters

ID of the object or resource.

currency
string

ISO 4217 currency code. Possible values include: CAD & USD. Note: as of today, currency supports a single value.

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".

product_name
string <= 255 characters

The name of the product or service your user signed up for on your platform.

Array of objects or null

Any rbit data your platform chooses to attach to this resource. The rbit data must be key-value pairs and can be an array of rbit objects.

reference_number
string [ 1 .. 255 ] characters

ID of the object or resource.

shipping_options
Array of strings or null unique

Description of each available shipping option.

object

Terms associated with the transaction.

uri
string <= 2063 characters ^https?://.+$

A valid, publicly available URL that works as an endpoint for HTTPS requests. This cannot be a local host. If for notification preferences, must be HTTPS.

object or null
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.

shipping_options
Array of strings or null unique

Description of each available shipping option.

object or null

Terms associated with the transaction.

uri
string or null <= 2063 characters ^https?://.+$

Primary URL of the legal entity.

object or null
400

INVALID_PARAMS

403

NOT_AUTHORIZED

500

UNEXPECTED_ERROR

Request samples
application/json
{
  • "account_id": "ABC123",
  • "description": "Classic Iron Anvil",
  • "photos": [ ],
  • "price": 490,
  • "product_code": "XYZ321",
  • "product_details": {
    • "band": "nike"
    },
  • "product_name": "Acme Anvil - 100 Lb",
  • "rbits": [
    • {
      • "address": {
        • "origin_address": {
          • "city": "Sunnyvale",
          • "country": "US",
          • "line1": "20 Main Street",
          • "postal_code": "94085",
          • "region": "CA"
          }
        },
      • "receive_time": 1367958263,
      • "source": "partner_database",
      • "type": "address"
      }
    ],
  • "reference_number": "abc_123456",
  • "shipping_options": [
    • "regular",
    • "expedited"
    ],
  • "terms": {},
  • "uri": "https://example.com/abc_123456",
  • "weight": {
    • "units": "pounds",
    • "weight": 1
    }
}
Response samples
application/json
{
  • "create_time": 1390656130,
  • "description": "Classic Iron Anvil",
  • "id": "f48cd8e6-e802-4500-a0f9-3ab6228c6f23",
  • "owner": {
    • "id": "d7608b20-fea5-4eb5-bd30-d3f58435e78b",
    • "path": "/accounts/d7608b20-fea5-4eb5-bd30-d3f58435e78b",
    • "resource": "accounts"
    },
  • "path": "/items/f48cd8e6-e802-4500-a0f9-3ab6228c6f23",
  • "photos": [ ],
  • "price": 490,
  • "product_code": "XYZ321",
  • "product_details": {
    • "band": "nike"
    },
  • "product_name": "Acme Anvil - 100 Lb",
  • "reference_number": "abc_123456",
  • "resource": "items",
  • "shipping_options": [
    • "regular",
    • "expedited"
    ],
  • "state": "deleted",
  • "terms": {},
  • "uri": "https://example.com/abc_123456",
  • "weight": {
    • "units": "pounds",
    • "weight": 1
    },
  • "api_version": "3.0"
}