Onboard outlet stock as second life (merchant self-listing)

Creates a Circular purchase owned by the merchant (no real customer, no voucher/credit) from its own catalog variants. Pre-validation is skipped; the purchase still follows the normal verify/approve/publish flow. A reverse label is generated only when an active shipping method is provided.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
items
array of objects
required
items*
methodId
object | null

Active shipping method id to generate a label. Null/omitted means no shipment and no label.

string
enum
Defaults to DropOff

How the shipment leaves the warehouse when a method is provided: DropOff (default), PickUp, Shop (left at a shop, label still generated) or Merchant (the marketplace ships it itself: no label, no tracking). It must be one of the types the method supports. Custom is not an option: it describes a customer shipping on their own.

Allowed:
desiredPickUp
object

Pick-up day. Required when shippingType is PickUp, rejected otherwise.

senderAddress
object
string

The draft this import was resumed from (/purchases/onboard/drafts). It is deleted with the import. Already imported or discarded: 409 DRAFT_GONE and nothing is created (send the import without draftId to create it anyway).

Responses

409

DRAFT_GONE: the draftId was already imported or discarded; nothing is created.

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