API Reference

Update a kit

patch
https://warehouse-api.sandbox.hurdle.bio/kits/

Updates the details of a sample kit.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params
string
required
string
string
string

Carrier code for return postage (e.g. ROYAL_MAIL, DPD_UK, DPD_LOCAL, UPS).

string

Optional. Full tracking URL for the return postage. Provide this only if you have it. Internally, a tracking URL is derived from the tracking code when possible; this field allows partners to supply their own URL when they already have one.

string

The shipping tracking number from the return postage label inside the kit (e.g. UPS shipping number).

string
string
date | null

Kit expiry date (YYYY-MM-DD). When set, registration of this kit is rejected starting the day after this date. null or omitted means no expiry enforcement.

date-time | null

ISO 8601 timestamp at which this kit was recalled. When set, any attempt to register this kit is rejected with HTTP 422 KIT_RECALLED. null or omitted means the kit has not been recalled.

Responses

Updated 9 days ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 9 days ago