Get orders
const url = 'https://acme.mykreezalid.com/api/v1/orders?id=185423%2C185424&status=new%2Caccepted&cart_id=432644&supplier_id=432244&customer_id=432245&order_number=2301FDSKFSDKL&start_on_date=2023-01-24&start_on_date%5Bvalue%5D=2023-01-24&start_on_date%5Bcondition_type%5D=gte&page=1&limit=25';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/v1/orders?id=185423%2C185424&status=new%2Caccepted&cart_id=432644&supplier_id=432244&customer_id=432245&order_number=2301FDSKFSDKL&start_on_date=2023-01-24&start_on_date%5Bvalue%5D=2023-01-24&start_on_date%5Bcondition_type%5D=gte&page=1&limit=25' \ --header 'Authorization: Basic <credentials>'Returns your orders, most recently checked out first, 25 per page by default. Draft orders (abandoned carts) are left out unless you ask for them with status.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”Keep only these orders: one identifier, a comma-separated list or an array (id[]=1&id[]=2).
Example
185423,185424Keep only the orders with these statuses, separated by commas. Without it, every status but draft is returned.
Example
new,acceptedKeep only the orders of these carts: one identifier, a comma-separated list or an array.
Example
432644Keep only the orders of these vendors: one identifier, a comma-separated list or an array.
Example
432244Keep only the orders of these customers: one identifier, a comma-separated list or an array.
Example
432245Keep only the orders with these numbers, separated by commas.
Example
2301FDSKFSDKLKeep only the orders with an item starting on this date. For another comparison, use start_on_date[value] and start_on_date[condition_type] instead.
Example
2023-01-24Date to compare the start date of the order’s items with. With in or notIn, a comma-separated list of dates.
Example
2023-01-24How to compare: greater than, greater than or equal, lower than, lower than or equal, equal, not equal, like, not like, in the list, not in the list. Both start_on_date[value] and start_on_date[condition_type] are needed, or the filter is ignored.
Example
gtePage to return, starting at 1.
Number of orders per page, at most 100.
Comma-separated list of the fields to return for each order, e.g. id,status,amount.
Responses
Section titled “Responses”A page of orders
object
A customer’s purchase from one vendor.
object
Order’s unique identifier
Same value as order_number
Total amount of the order
Total amount formatted with its currency
Amount due to the vendor
Amount of the order when the customer checked out, before any change
Whether some items of the order were declined
A member of your marketplace, customer or vendor, as the Admin API returns it.
object
User’s unique identifier
Your own identifier for this user
Two-letter country code
Values of the user’s custom profile fields
object
Absolute URL of the profile image
Company or organization name
Whether the user’s group may publish listings
Whether the user’s group goes through onboarding
Company details. Absent when account_type is individual.
object
Company registration number
Sign-up date, YYYY-MM-DD HH:MM:SS
object
Group’s unique identifier
Identifier of the user’s group. Deprecated in responses: read group.id.
Read group.name.
Read group.alias.
Language code
Number of the user’s listings
Number of the user’s listings, whatever their status
Same value as lang
The user’s metafields, when they are loaded; null otherwise
A custom value you attach to a resource, identified by its namespace and title.
object
Group the metafield belongs to
Name of the metafield, unique within its namespace
Value of the metafield. Usually a string; it can be returned as a number or a JSON value depending on how the metafield was defined.
Two-letter country code
Average rating from the reviews the user received
Absolute URL of the user’s public profile
Name shown publicly, following your display settings
Account status
Whether the user completed their identity details
Number of reviews the user received
A member of your marketplace, customer or vendor, as the Admin API returns it.
object
User’s unique identifier
Your own identifier for this user
Two-letter country code
Values of the user’s custom profile fields
object
Absolute URL of the profile image
Company or organization name
Whether the user’s group may publish listings
Whether the user’s group goes through onboarding
Company details. Absent when account_type is individual.
object
Company registration number
Sign-up date, YYYY-MM-DD HH:MM:SS
object
Group’s unique identifier
Identifier of the user’s group. Deprecated in responses: read group.id.
Read group.name.
Read group.alias.
Language code
Number of the user’s listings
Number of the user’s listings, whatever their status
Same value as lang
The user’s metafields, when they are loaded; null otherwise
A custom value you attach to a resource, identified by its namespace and title.
object
Group the metafield belongs to
Name of the metafield, unique within its namespace
Value of the metafield. Usually a string; it can be returned as a number or a JSON value depending on how the metafield was defined.
Two-letter country code
Average rating from the reviews the user received
Absolute URL of the user’s public profile
Name shown publicly, following your display settings
Account status
Whether the user completed their identity details
Number of reviews the user received
Message the customer left at checkout
Checkout date, as a Unix timestamp; null when the checkout did not complete
Code the customer gives the vendor on a hand delivery
Whether the funds were captured at checkout (true), or only authorized then, to be captured later (false)
Billing address; an empty array when the order has none
object
Last name and first name
The order’s metafields; null when it has none
A custom value you attach to a resource, identified by its namespace and title.
object
Group the metafield belongs to
Name of the metafield, unique within its namespace
Value of the metafield. Usually a string; it can be returned as a number or a JSON value depending on how the metafield was defined.
The shop the order is collected from, when all its items come from one shop. Absent otherwise.
object
object
Tracking URL of the parcel, or the tracking number when there is no URL
Details of the pickup point chosen by the customer, as HTML, when the carrier uses pickup points
Identifier of the pickup point chosen by the customer
object
Last name and first name
Who receives the shipping fees; empty when the order does not require shipping
object
success once an amount has been paid out to the vendor, not_available otherwise
Amount paid out to the vendor
Amount paid out, formatted with its currency
When the payout was requested from the payment provider, as a Unix timestamp
When the payment provider sent the payout to the bank, as a Unix timestamp
When the funds reach the bank account, as a Unix timestamp
Fees applied to the order. Absent when there are none.
object
The items of the order. Absent when it has none.
object
Order item’s unique identifier
Total amount of the item
Options chosen for the item
A listing (product or service) of your marketplace. Read-only fields are returned in responses; write-only fields are only accepted when you create or update a listing.
object
Listing’s unique identifier
Admin validation status of the listing: waiting (awaiting approval), approved (visible if the status is also published), rejected or blocked (hidden from the marketplace). On creation it defaults to approved, or to blocked when is_online is 0.
Values of the listing attributes, keyed by attribute alias (see List listing attributes). When writing, a select or checkbox attribute accepts option identifiers or option titles (several values as an array or separated by ##); a title that matches no existing option creates that option. Unknown aliases are ignored.
object
Add-ons of the listing, null when there are none
An extra product or service a buyer can add to a listing, such as gift wrapping or an extended warranty.
object
Add-on’s unique identifier
Unique identifier of the listing the add-on belongs to
Price of the add-on, with up to two decimal places
Address of the listing, grouped
object
Category of the listing. On write you can also send category with an id, or with a title matching an existing category, instead of category_id.
object
Unique identifier of the listing’s category. Required on creation.
URL of the cover image
Date the listing went online
Description of the listing. Required on creation. HTML you send is converted to plain text.
Your own reference for the listing
Price formatted for display, with its currency and price unit; may contain HTML
Set to 0 on creation to create the listing as a draft, blocked by an admin, unless you send status or admin_status yourself.
Minimum quantity a buyer must order
Logistic category of the listing
object
Images attached to the listing, as returned in responses, null when there are none. On create and update this name is also accepted as an alias of images and takes the same value, a list of image URLs; if both are sent, images wins. Prefer images when writing — the alias exists so that posting back the field name you read does not fail silently.
object
Images to attach to the listing, as a JSON array of publicly reachable image URLs; a single URL on its own is accepted too. Each URL is downloaded server-side and re-uploaded to our own storage, so the source only needs to stay reachable for the duration of the request; the stored copy is returned in medias. The order of the array is the display order. On update, sending images replaces the whole set, so any existing image you want to keep must be sent again. Omit the field to leave the current images untouched. medias is accepted as an alias of this field.
Unique identifier of the listing’s order type (see List order types). On creation, when it is missing or unknown, the first available order type is used.
URL token of an order type (see List order types), as an alternative to order_type_id
Order type of the listing
object
Price before discount
Whether the listing is shown on the homepage
Price of the listing. Required (and not zero) on creation.
Title of the price unit, for example per night
Quantity available for sale
Shipping methods selected for the listing
object
Public status of the listing: draft, published (visible) or archived (hidden). On creation, a listing is created as published, or as a draft when is_online is 0 and no status is sent.
A member of your marketplace, customer or vendor, as the Admin API returns it.
object
User’s unique identifier
Your own identifier for this user
Two-letter country code
Values of the user’s custom profile fields
object
Absolute URL of the profile image
Company or organization name
Whether the user’s group may publish listings
Whether the user’s group goes through onboarding
Company details. Absent when account_type is individual.
object
Company registration number
Sign-up date, YYYY-MM-DD HH:MM:SS
object
Group’s unique identifier
Identifier of the user’s group. Deprecated in responses: read group.id.
Read group.name.
Read group.alias.
Language code
Number of the user’s listings
Number of the user’s listings, whatever their status
Same value as lang
The user’s metafields, when they are loaded; null otherwise
A custom value you attach to a resource, identified by its namespace and title.
object
Group the metafield belongs to
Name of the metafield, unique within its namespace
Value of the metafield. Usually a string; it can be returned as a number or a JSON value depending on how the metafield was defined.
Two-letter country code
Average rating from the reviews the user received
Absolute URL of the user’s public profile
Name shown publicly, following your display settings
Account status
Whether the user completed their identity details
Number of reviews the user received
A member of your marketplace, customer or vendor, as the Admin API returns it.
object
User’s unique identifier
Your own identifier for this user
Two-letter country code
Values of the user’s custom profile fields
object
Absolute URL of the profile image
Company or organization name
Whether the user’s group may publish listings
Whether the user’s group goes through onboarding
Company details. Absent when account_type is individual.
object
Company registration number
Sign-up date, YYYY-MM-DD HH:MM:SS
object
Group’s unique identifier
Identifier of the user’s group. Deprecated in responses: read group.id.
Read group.name.
Read group.alias.
Language code
Number of the user’s listings
Number of the user’s listings, whatever their status
Same value as lang
The user’s metafields, when they are loaded; null otherwise
A custom value you attach to a resource, identified by its namespace and title.
object
Group the metafield belongs to
Name of the metafield, unique within its namespace
Value of the metafield. Usually a string; it can be returned as a number or a JSON value depending on how the metafield was defined.
Two-letter country code
Average rating from the reviews the user received
Absolute URL of the user’s public profile
Name shown publicly, following your display settings
Account status
Whether the user completed their identity details
Number of reviews the user received
A member of your marketplace, customer or vendor, as the Admin API returns it.
object
User’s unique identifier
Your own identifier for this user
Two-letter country code
Values of the user’s custom profile fields
object
Absolute URL of the profile image
Company or organization name
Whether the user’s group may publish listings
Whether the user’s group goes through onboarding
Company details. Absent when account_type is individual.
object
Company registration number
Sign-up date, YYYY-MM-DD HH:MM:SS
object
Group’s unique identifier
Identifier of the user’s group. Deprecated in responses: read group.id.
Read group.name.
Read group.alias.
Language code
Number of the user’s listings
Number of the user’s listings, whatever their status
Same value as lang
The user’s metafields, when they are loaded; null otherwise
A custom value you attach to a resource, identified by its namespace and title.
object
Group the metafield belongs to
Name of the metafield, unique within its namespace
Value of the metafield. Usually a string; it can be returned as a number or a JSON value depending on how the metafield was defined.
Two-letter country code
Average rating from the reviews the user received
Absolute URL of the user’s public profile
Name shown publicly, following your display settings
Account status
Whether the user completed their identity details
Number of reviews the user received
Unique identifier of the vendor (user) who owns the listing. Required on creation.
Title of the listing. Required on creation.
Full URL of the listing page on your marketplace
Variants of the listing, null when there are none. On update, send the full list: each variant is matched to an existing one by external_id, then by sku; a variant with no match is created, and every existing variant missing from the list is deleted.
A version of a listing that differs by size, color or any other characteristic, with its own price, SKU and stock.
object
Variant’s unique identifier
Your own reference for the variant
Unique identifier of the listing the variant belongs to
The quantity of the variant that is available for sale
Sorts the variants with the lowest number first. Negative numbers are allowed.
Unique identifier of the listing image used for this variant
Where the listing is displayed: both (catalog and search), catalog (only the catalog), search (only search results) or none (not visible). Defaults to both on creation.
Metafields of the listing, grouped by namespace then by title
object
Date of the next availability, for listings that have one
Settings the listing inherits from its order type, such as whether payment, shipping or stock are enabled
object
Status of the item; new until the vendor handles it
Why the vendor declined the item
Paging information, added next to the results of a paginated list. Request another page with the page query parameter and change the page size with limit (at most 100).
object
Number of results across all pages.
Number of the page returned, starting at 1.
Whether a next page exists.
Whether a previous page exists.
Number of results on this page.
Number of pages.
Example
{ "orders": [ { "object": "Order", "amount": 129.9, "status": "draft", "supplier": { "id": 545353, "object": "User", "external_id": "ABCdef123456", "account_type": "individual", "address_city": "New-York City", "address_country": "US", "address_line1": "253 W 42nd St", "address_line2": null, "address_state": "NY", "address_zipcode": "10036", "attributes": { "profession": "Web developer" }, "birthday": "1990-05-17", "business_name": "ACME", "company": { "object": "Company", "name": "ACME" }, "created_at": "2024-03-18 09:41:05", "email": "jane@example.com", "first_name": "Jane", "group": { "object": "Group", "id": 784568, "name": "VIP Customers", "alias": "vip-customers" }, "group_id": 784568, "lang": "en", "last_name": "Doe", "listing_count": 12, "listing_count_any_status": 14, "locale": "en", "metafields": [ { "namespace": "erp", "title": "warehouse_code", "value": "WH-42" } ], "nationality": "US", "average_rating": 4.5, "phone_country_code": "+1", "phone_number": "212-398-2600", "profile_url": "https://acme.mykreezalid.com/shop/a1b2c3d/jane-doe", "public_name": "Jane Doe", "status": "enabled", "identity_status": "not_completed", "review_count": 3, "timezone": "America/New_York", "username": "janedoe" }, "customer": { "id": 545353, "object": "User", "external_id": "ABCdef123456", "account_type": "individual", "address_city": "New-York City", "address_country": "US", "address_line1": "253 W 42nd St", "address_line2": null, "address_state": "NY", "address_zipcode": "10036", "attributes": { "profession": "Web developer" }, "birthday": "1990-05-17", "business_name": "ACME", "company": { "object": "Company", "name": "ACME" }, "created_at": "2024-03-18 09:41:05", "email": "jane@example.com", "first_name": "Jane", "group": { "object": "Group", "id": 784568, "name": "VIP Customers", "alias": "vip-customers" }, "group_id": 784568, "lang": "en", "last_name": "Doe", "listing_count": 12, "listing_count_any_status": 14, "locale": "en", "metafields": [ { "namespace": "erp", "title": "warehouse_code", "value": "WH-42" } ], "nationality": "US", "average_rating": 4.5, "phone_country_code": "+1", "phone_number": "212-398-2600", "profile_url": "https://acme.mykreezalid.com/shop/a1b2c3d/jane-doe", "public_name": "Jane Doe", "status": "enabled", "identity_status": "not_completed", "review_count": 3, "timezone": "America/New_York", "username": "janedoe" }, "checkout_at": 1700000000, "billing_address": { "object": "Address" }, "metafields": [ { "namespace": "erp", "title": "warehouse_code", "value": "WH-42" } ], "fulfillment_status": "started", "shipping_fees_destination": "platform", "payout": { "status": "not_available" }, "order_items": [ { "listing": { "id": 645646, "object": "Listing", "admin_status": "waiting", "attributes": { "color": "Blue", "material": "Leather" }, "add_ons": [ { "id": 4242, "object": "Addon", "listing_id": 324353, "title": "Extended Warranty", "description": "Protect your purchases beyond the standard warranty period", "price": 12.5 } ], "category": { "object": "Category", "id": 4242, "title": "Shoes", "slug": "shoes", "url": "/c/shoes" }, "category_id": 432432, "city": "New York City", "country": "US", "currency": "USD", "date_online": "2026-10-01 09:30:00", "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", "formatted_price": "$123.50", "is_online": true, "lat": 40.7572114, "lng": -73.9913385, "location": "253 W 42nd St, New York, NY 10036, United States", "min_qty": 1, "logistic_category": { "object": "LogisticCategory", "id": 4242 }, "medias": [ { "object": "Media", "id": 4242, "position": 0, "media_type": "image" } ], "images": [ "https://example.com/photo-front.jpg", "https://example.com/photo-back.jpg" ], "order_type_id": 986545, "order_type": { "object": "OrderType", "id": 4242, "title": "Sale", "transaction_type": "selling" }, "original_price": 150, "on_homepage": false, "price": 123.5, "price_unit": null, "price_with_currency": "$123.50", "quantity": 43, "quantity_selector": null, "requires_shipping": true, "sku": "SKU_123", "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", "supplier": { "id": 545353, "object": "User", "external_id": "ABCdef123456", "account_type": "individual", "address_city": "New-York City", "address_country": "US", "address_line1": "253 W 42nd St", "address_line2": null, "address_state": "NY", "address_zipcode": "10036", "attributes": { "profession": "Web developer" }, "birthday": "1990-05-17", "business_name": "ACME", "company": { "object": "Company", "name": "ACME" }, "created_at": "2024-03-18 09:41:05", "email": "jane@example.com", "first_name": "Jane", "group": { "object": "Group", "id": 784568, "name": "VIP Customers", "alias": "vip-customers" }, "group_id": 784568, "lang": "en", "last_name": "Doe", "listing_count": 12, "listing_count_any_status": 14, "locale": "en", "metafields": [ { "namespace": "erp", "title": "warehouse_code", "value": "WH-42" } ], "nationality": "US", "average_rating": 4.5, "phone_country_code": "+1", "phone_number": "212-398-2600", "profile_url": "https://acme.mykreezalid.com/shop/a1b2c3d/jane-doe", "public_name": "Jane Doe", "status": "enabled", "identity_status": "not_completed", "review_count": 3, "timezone": "America/New_York", "username": "janedoe" }, "owner": { "id": 545353, "object": "User", "external_id": "ABCdef123456", "account_type": "individual", "address_city": "New-York City", "address_country": "US", "address_line1": "253 W 42nd St", "address_line2": null, "address_state": "NY", "address_zipcode": "10036", "attributes": { "profession": "Web developer" }, "birthday": "1990-05-17", "business_name": "ACME", "company": { "object": "Company", "name": "ACME" }, "created_at": "2024-03-18 09:41:05", "email": "jane@example.com", "first_name": "Jane", "group": { "object": "Group", "id": 784568, "name": "VIP Customers", "alias": "vip-customers" }, "group_id": 784568, "lang": "en", "last_name": "Doe", "listing_count": 12, "listing_count_any_status": 14, "locale": "en", "metafields": [ { "namespace": "erp", "title": "warehouse_code", "value": "WH-42" } ], "nationality": "US", "average_rating": 4.5, "phone_country_code": "+1", "phone_number": "212-398-2600", "profile_url": "https://acme.mykreezalid.com/shop/a1b2c3d/jane-doe", "public_name": "Jane Doe", "status": "enabled", "identity_status": "not_completed", "review_count": 3, "timezone": "America/New_York", "username": "janedoe" }, "user": { "id": 545353, "object": "User", "external_id": "ABCdef123456", "account_type": "individual", "address_city": "New-York City", "address_country": "US", "address_line1": "253 W 42nd St", "address_line2": null, "address_state": "NY", "address_zipcode": "10036", "attributes": { "profession": "Web developer" }, "birthday": "1990-05-17", "business_name": "ACME", "company": { "object": "Company", "name": "ACME" }, "created_at": "2024-03-18 09:41:05", "email": "jane@example.com", "first_name": "Jane", "group": { "object": "Group", "id": 784568, "name": "VIP Customers", "alias": "vip-customers" }, "group_id": 784568, "lang": "en", "last_name": "Doe", "listing_count": 12, "listing_count_any_status": 14, "locale": "en", "metafields": [ { "namespace": "erp", "title": "warehouse_code", "value": "WH-42" } ], "nationality": "US", "average_rating": 4.5, "phone_country_code": "+1", "phone_number": "212-398-2600", "profile_url": "https://acme.mykreezalid.com/shop/a1b2c3d/jane-doe", "public_name": "Jane Doe", "status": "enabled", "identity_status": "not_completed", "review_count": 3, "timezone": "America/New_York", "username": "janedoe" }, "user_id": 655785, "title": "Blue leather shoes", "variants": [ { "id": 432432, "object": "Variant", "external_id": "INTERNAL_REF_234324", "listing_id": 324353, "price": 123.5, "price_unit": null, "quantity": 10, "sort_priority": 10, "sku": "BASKT-XYZ-BLN-41", "title": "Blue Shoes Size 41", "weight": 0.8, "cover_id": 4242 } ], "visibility": "both", "weight": 0.8, "weight_unit": "kg", "metafields": { "erp": { "warehouse_code": "WH-42" } } }, "status": "new" } ] } ], "pagination": { "totalResultsCount": 137, "currentPage": 1, "resultOnPageCount": 25, "pageCount": 6 }}An identifier filter is not an identifier or a list of identifiers.