List orders on your listings
Authorization
apiKey API key created in your Marka account settings, sent as an x-api-key header (an Authorization: Bearer mk_… header is accepted as an equivalent spelling). Key-authenticated writes additionally require the api_write entitlement, which the Pro plan and above carry. A signed-in browser session cookie is also accepted for interactive exploration from the Marka web app; SDK and server-to-server clients always use a key.
In: header
Query Parameters
Page size, 1-100. Defaults to 50.
1 <= value <= 100Number of records to skip. Defaults to 0.
0 <= value <= 9007199254740991Restrict to a single order status. Omit for all statuses.
Value in
- "created"
- "checkout_pending"
- "payment_captured"
- "seller_accepted"
- "scheduled"
- "inspecting"
- "packing"
- "shipped"
- "delivered"
- "inspection_window"
- "completed"
- "abandoned"
- "cancelled"
- "refunded"
- "buyer_no_show"
- "seller_no_show"
- "rejected_at_pickup"
- "dispute_open"
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/orders"{ "hasMore": true, "limit": 1, "offset": 0, "orders": [ { "buyerId": "string", "checkoutShippingDetails": { "address": { "city": "string", "country": "string", "line1": "string", "line2": "string", "postal_code": "string", "state": "string" }, "email": "string", "name": "string", "phone": "string" }, "connectedAccountId": "string", "createdAt": "2019-08-24T14:15:22Z", "disputeState": "none", "fulfillmentMode": "PICKUP", "id": "string", "listingId": "string", "listingSnapshot": { "acceptsOffers": true, "attributes": "string", "authority": "MARKA", "autoAcceptOfferAmount": 0, "brand": "string", "categoryPath": "string", "checkoutEnabled": true, "condition": "new", "createdAt": "2019-08-24T14:15:22Z", "currency": "string", "description": "string", "directEnabled": true, "gtin": "string", "id": "string", "imageUrls": [ "string" ], "inventoryType": "unique", "location": { "addressLine1": "string", "addressLine2": "string", "city": "string", "country": "string", "latitude": -90, "longitude": -180, "postalCode": "string", "region": "string" }, "madeInCountry": "string", "packageDimensionsMm": { "heightMm": 0, "lengthMm": 0, "widthMm": 0 }, "packageWeightGrams": 0, "pickupEnabled": true, "price": 0, "quantityReserved": 0, "quantityTotal": 0, "riskCategory": "general", "sellerAccountId": "string", "shippingEnabled": true, "shippingFlatAmount": 0, "shippingProfileId": "string", "status": "draft", "title": "string", "updatedAt": "2019-08-24T14:15:22Z", "visibilityRadiusKm": 1 }, "paymentId": "string", "pickupSessionId": "string", "priceSnapshot": { "applicationFeeAmount": -9007199254740991, "currency": "string", "itemSubtotal": -9007199254740991, "shippingAmount": -9007199254740991, "taxAmount": -9007199254740991 }, "protectionTier": "DIRECT_BASIC", "quantity": 1, "rail": "DIRECT", "reviewEligibilityState": "not_eligible", "sellerAccountId": "string", "shipmentId": "string", "status": "created", "stripeCheckoutSessionId": "string", "updatedAt": "2019-08-24T14:15:22Z" } ]}List your listings GET
Previous Page
Publish a draft listing POST
Publishing requires available stock (quantityTotal - quantityReserved > 0) for both unique and multi-quantity inventory. Otherwise returns HTTP 400 with code out_of_stock and message All units are held by open orders. when quantityTotal > 0, or Active listings require stock. when quantityTotal is 0.