Retrieve order
const url = 'https://acme.mykreezalid.com/api/partners/v1/orders/1';const options = {method: 'GET', headers: {Authorization: 'Basic <credentials>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://acme.mykreezalid.com/api/partners/v1/orders/1 \ --header 'Authorization: Basic <credentials>'Returns one of the orders received by your vendor account.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”ID of your order
Responses
Section titled “Responses”Success
object
object
Order’s unique identifier
object
User’s unique identifier
Absolute URL of the profile image
Company or organization name
object
Group’s unique identifier
Average note based on reviews
Account status. Possible values are “enabled2” or “disabled”
object
User’s unique identifier
Absolute URL of the profile image
Company or organization name
object
Group’s unique identifier
Average note based on reviews
Account status. Possible values are “enabled2” or “disabled”
object
object
First name and last name
object
The payout status depends on the payment provider of the marketplace
The payout amount in cents
Three-letter ISO 4217 currency code, in lowercase
The payout has been requested from the payment provider
The payout has been submitted to the bank by the payment provider
Date of arrival of the funds in the bank account
object
object
Order item’s unique identifier
object
Listing’s unique identifier
Admin validation status of the listing. Possible values: waiting (awaiting approval), approved (visible if status also published), rejected (hidden from the marketplace).
object
Category’s unique identifier
Category’s unique identifier
Order type’s unique identifier
object
Public status of the listing. Possible values: draft, published (visible), archived (hidden).
The store that holds this listing, by its id (as returned by GET /stores). The listing then shows at that store’s address, and buyers are told where to collect it. Leave the field out entirely to keep whatever store it already had. To move the listing, send the store it moves TO: a listing already in a store CANNOT be taken out of one by sending an empty value, because attaching replaced its own address and there is none to fall back to — unpublish it instead. A store that is not one of yours is refused. Send either store_id or store_external_id, not both.
Optional alternative to store_id: YOUR OWN code for the store, the external_id you gave it. Only usable for a store that has one. Same rules as store_id: leave it out to keep the current store, send the code of the store the listing moves to, an empty value cannot take a listing out of its store. Send either store_id or store_external_id, not both.
object
User’s unique identifier
Absolute URL of the profile image
Company or organization name
object
Group’s unique identifier
Average note based on reviews
Account status. Possible values are “enabled2” or “disabled”
Supplier’s unique identifier
object
Variant’s unique identifier
The quantity of the variant that is available for sale
Sorts the variants with the lowest number first. Negative numbers are allowed.
Defines where the listing is displayed. Possible values: both (visible in catalog and search), catalog (only catalog), search (only search results), none (not visible).
Example
{ "order": { "supplier": { "id": 545353, "object": "User", "account_type": "individual", "external_id": "ABCdef123456", "address_city": "New-York City", "address_country": "US", "address_line1": "253 W 42nd St", "address_line2": null, "address_state": "NY", "address_zipcode": "NY 10036", "attributes": { "profession": "Web developer" }, "business_name": "ACME", "email": "admin@acme.com", "first_name": "John", "group": [ { "object": "Group", "id": 784568, "name": "VIP Customers", "alias": "vip-customers" } ], "group_id": 784568, "last_name": "Doe", "locale": "en", "note": "4.5", "phone_country_number": "+1", "phone_number": "212-398-2600", "public_name": "John Doe", "status": "enabled", "store_id": "123456", "review_count": "3", "timezone": "UTC", "username": "BestJohnDoe" }, "customer": { "id": 545353, "object": "User", "account_type": "individual", "external_id": "ABCdef123456", "address_city": "New-York City", "address_country": "US", "address_line1": "253 W 42nd St", "address_line2": null, "address_state": "NY", "address_zipcode": "NY 10036", "attributes": { "profession": "Web developer" }, "business_name": "ACME", "email": "admin@acme.com", "first_name": "John", "group": [ { "object": "Group", "id": 784568, "name": "VIP Customers", "alias": "vip-customers" } ], "group_id": 784568, "last_name": "Doe", "locale": "en", "note": "4.5", "phone_country_number": "+1", "phone_number": "212-398-2600", "public_name": "John Doe", "status": "enabled", "store_id": "123456", "review_count": "3", "timezone": "UTC", "username": "BestJohnDoe" }, "fulfillment_status": "started", "shipping_fees_destination": "platform", "order_items": [ { "listing": { "id": 645646, "object": "Listing", "admin_status": "waiting", "attributes": "[]", "category": { "id": 432432, "object": "Category" }, "category_id": 432432, "city": "New York City", "country": "US", "currency": "USD", "description": "<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla dignissim laoreet sem, quis mollis elit rutrum a. Donec nunc urna, rhoncus in sagittis ut, elementum scelerisque libero. Quisque interdum nibh nisl, non gravida nibh molestie quis. Phasellus nunc nunc, luctus a luctus ac, iaculis sit amet turpis.</p><p>Phasellus tortor orci, posuere in mi at, blandit ullamcorper tellus. Proin vel sem aliquam, faucibus dolor quis, dictum leo. Aliquam consectetur massa at ipsum auctor, at mattis nunc porttitor. Suspendisse potenti. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus.</p>", "external_id": "INTERNAL_REF_234324", "lat": 40.7572114, "lng": -73.9913385, "location": "253 W 42nd St, New York, NY 10036, United States", "min_qty": 1, "order_type_id": 986545, "price": 123.5, "price_unit": null, "price_with_currency": "$123.50", "quantity": 43, "quantity_selector": null, "requires_shipping": true, "shipping_methods": [ { "id": 1, "carrier_alias": "fed_ex", "price": 4.95, "sort_priority": 4, "step_price": 0.95, "title": "FedEx" } ], "slug": "listing-s-slug", "state": "NY", "status": "draft", "store_id": 217833, "store_external_id": "SHOP-BRUSSELS-01", "supplier": { "id": 545353, "object": "User", "account_type": "individual", "external_id": "ABCdef123456", "address_city": "New-York City", "address_country": "US", "address_line1": "253 W 42nd St", "address_line2": null, "address_state": "NY", "address_zipcode": "NY 10036", "attributes": { "profession": "Web developer" }, "business_name": "ACME", "email": "admin@acme.com", "first_name": "John", "group": [ { "object": "Group", "id": 784568, "name": "VIP Customers", "alias": "vip-customers" } ], "group_id": 784568, "last_name": "Doe", "locale": "en", "note": "4.5", "phone_country_number": "+1", "phone_number": "212-398-2600", "public_name": "John Doe", "status": "enabled", "store_id": "123456", "review_count": "3", "timezone": "UTC", "username": "BestJohnDoe" }, "supplier_id": 655785, "title": "Listing's title", "variants": { "id": 432432, "object": "Variant", "external_id": "INTERNAL_REF_234324", "listing_id": 324353, "price": 123.5, "price_unit": null, "quantity": "1", "sort_priority": "0", "sku": "BASKT-XYZ-BLN-41", "title": "Blue Shoes Size 41", "weight": 0.8 }, "visibility": "both", "weight": 0.8 } } ] }}Missing or wrong API credentials.
No order of yours has this ID.