Items

Reading a lot of item history?

For backfills, exports and reporting, the BigQuery SDK (JavaScript) reads items from your UltraCart data warehouse in one query and returns the same Item objects as this API, fully expanded, without REST rate limits. Its change log also keeps every version of each item, including deletes, so you can sync only what changed: the REST API returns only the current version. See BigQuery SDK Quickstart.

Add a single gated access code to an item

POST/item/items/{merchant_item_oid}/gated_codes

Insert a single gated access code; the server assigns the OID and created_dts.

Create a file within the digital library

POST/item/digital_library

Create a file within the digital library.

Create an item

POST/item/items

Create a new item on the UltraCart account.

Delete a digital item, which is a file within the digital library, not an actual merchant item

DELETE/item/digital_library/{digital_item_oid}

Delete a digital item on the UltraCart account.

Delete a gated access code by OID

DELETE/item/items/{merchant_item_oid}/gated_codes/{merchant_item_gated_code_oid}

Delete a specific gated access code by its OID.

Delete a review

DELETE/item/items/{merchant_item_oid}/reviews/{review_oid}

Delete an item review.

Delete all gated access codes for an item

DELETE/item/items/{merchant_item_oid}/gated_codes

Removes every gated access code currently configured for the item.

Delete an item

DELETE/item/items/{merchant_item_oid}

Delete an item on the UltraCart account.

Generate a batch of gated access codes

POST/item/items/{merchant_item_oid}/gated_codes/generate

Returns randomly generated codes using a profanity-safe charset (vowel-free, 0/1 removed).

Get a review

GET/item/items/{merchant_item_oid}/reviews/{review_oid}

Retrieve an item review.

Get gated access codes for an item

GET/item/items/{merchant_item_oid}/gated_codes

Retrieve all unredeemed gated access codes configured for an item.

Get reviews for an item

GET/item/items/{merchant_item_oid}/reviews

Retrieve item reviews.

Insert a review

POST/item/items/{merchant_item_oid}/reviews

Insert a item review.

Replace the full list of gated access codes for an item

PUT/item/items/{merchant_item_oid}/gated_codes

Existing codes not present in the request body are deleted.

Retrieve a digital item from the digital library, which are digital files that may be attached to normal items

GET/item/digital_library/{digital_item_oid}

Retrieves a digital item (file information) from the account.

Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.

GET/item/items/inventory_snapshot

Retrieve a list of item inventories.

Retrieve an item

GET/item/items/{merchant_item_oid}

Retrieves a single item using the specified item oid.

Retrieve an item by item id

GET/item/items/merchant_item_id/{merchant_item_id}

Retrieves a single item using the specified item id.

Retrieve digital items from the digital library (which are digital files that may be attached to normal items) not yet associated with actual items

GET/item/digital_library/unassociated

Retrieves a group of digital items (file information) from the account that are not yet associated with any actual items.

Retrieve digital items from the digital library which are digital files that may be attached to normal items

GET/item/digital_library

Retrieves a group of digital items (file information) from the account.

Retrieve items

GET/item/items

Retrieves a group of items from the account.

Retrieve pricing tiers

GET/item/pricing_tiers

Retrieves the pricing tiers

Retrieves digital items from the digital library (which are digital files that may be attached to normal items) that having a matching external id

GET/item/digital_library/by_external/{external_id}

Retrieves digital items from the digital library (which are digital files that may be attached to normal items) that having a matching external id.

Update a review

PUT/item/items/{merchant_item_oid}/reviews/{review_oid}

Update an item review.

Update an item

PUT/item/items/{merchant_item_oid}

Update a new item on the UltraCart account.

Update multiple items

PUT/item/items/batch

Update multiple item on the UltraCart account.

Updates a file within the digital library

PUT/item/digital_library/{digital_item_oid}

Updates a file within the digital library.

Upload an image to the temporary multimedia.

POST/item/temp_multimedia

Uploads an image and returns back meta information about the image as well as the identifier needed for the item update.

Upsert an item content attribute

POST/item/items/{merchant_item_oid}/content/attributes

Update an item content attribute, creating it new if it does not yet exist.

Webhooks

The following webhook events are available for this resource. See Webhooks for how delivery, retries, and versioning work.

Event	Description	Reflow	Expandable
item_create	Fired when a new item is created.	—	Yes
item_delete	Fired when an item is deleted.	—	Yes
item_update	Fired when an item is updated.	Yes	Yes

Receiving these events

• Payload: each delivery is a POST whose JSON body is an array of events, even when it carries one. Each element has a single key, the event name, whose value is the object, for example [{"item_create": {...}}].
• Contents: the object includes only the parts in the webhook's expansion. Expansions appear when you edit the webhook after creating it.
• Respond within 30 seconds. Store or queue the payload and do the work in a background job.
• Batching: one delivery can bundle several events. The webhook sets how many (10 or more) and the maximum payload size (up to 900K).
• HTTPS: use it. It is required whenever the payload includes customer information.
• Testing: the webhook's test button sends a delivery, and its log shows each one. To resend existing records, for example to backfill a new receiver, request a reflow.

More: Webhooks, Creating a simple webhook (with a sample payload), receiver samples in PHP and Python