GOgolocad
Marketplace Orders (B2C)

List Orders

List all orders created in our System (Locad OMS) from all integrated marketplaces (Shopify, Shopee, Lazada, Custom, etc.). The endpoint supports extensive filtering capabilities including order timeframes, payment methods, fulfillment status, marketplace status, geographical filters, and more. Refer to the query parameters for all available filtering options.

get/openapi/{version}/marketplace_orders/

Request

  • Base URL
    https://base_url
  • Auth
    none declared

Path parameters

versionstring required

Query parameters

countrystring

Filter by country code. Example: ?country=PH

created_afterstring

Retrieve all orders created after the given datetime (referring to marketplace_create_time in the order). Example: ?created_after=2024-01-01:00:00:00

created_beforestring

Retrieve all orders created before the given datetime (referring to marketplace_create_time in the order). Example: ?created_before=2024-01-01:00:00:00

destination_citystring

Filter orders by order's destination city name (shipping address). Example: ?destination_city=Makati

destination_countrystring

Filter orders by order's destination country code (shipping address). Example: ?destination_country=PH

destination_statestring

Filter orders by order's destination state name (shipping address). Example: ?destination_state=Manila

has_waybillstring

Filter orders based on waybill is available or not. Example: ?has_waybill=Yes

is_draftstring

Use this filter to get all draft orders. Example: ?is_draft=false

is_editedstring

Use this filter to get all edited orders. Example: ?is_edited=false

last_mile_statusstring

Filter by Last Mile Status (comma-separated). Example: ?last_mile_status=IN_TRANSIT,DELIVERED

limitinteger

Number of results to return per page.

marketplacestring

Filter by marketplace connection name. Example: ?marketplace=ShopName

marketplace_statusstring

Filter by Marketplace Status (comma-separated). Example: ?marketplace_status=IN_TRANSIT,NEW

marketplace_type'amazon' | 'bbo' | 'capillary' | 'custom' | 'ebay' | 'erpstore' | 'ginee' | 'kumu' | 'lazada' | 'mockmarketplace' | 'noon' | 'salla' | 'shopee' | 'shopify' | 'temu' | 'tiktok' | 'tokopedia' | 'wix' | 'woocommerce' | 'zalora' | 'zid'

Filter by marketplace type. Example: ?marketplace_type=shopify

offsetinteger

The initial index from which to return the results.

orderingstring

Which field to use when ordering the results.

payment_methodstring

Filter by payment_method (comma-separated). Example: ?payment_method=COD,Card

searchstring

Search by marketplace_order_ref or marketplace_order_id. Example: ?search=ordertest123

warehouse_statusstring

Filter by Warehouse Status (comma-separated). Example: ?warehouse_status=ON_HOLD,CANCELLED

Response

List all orders

successboolean
messagestring required

Changes

No recorded changes to this operation across all 1 revision of this API.