--- title: "List Orders" method: GET path: "/openapi/{version}/marketplace_orders/" tags: ["Marketplace Orders (B2C)"] --- # List Orders `GET /openapi/{version}/marketplace_orders/` ## Request - Base URL: `https://base_url` - URL: `https://base_url/openapi/{version}/marketplace_orders/` - Auth: none declared 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. ## Path parameters - `version` string, required ## Query parameters - `country` string - `created_after` string - `created_before` string - `destination_city` string - `destination_country` string - `destination_state` string - `has_waybill` string - `is_draft` string - `is_edited` string - `last_mile_status` string - `limit` integer - `marketplace` string - `marketplace_status` string - `marketplace_type` 'amazon' | 'bbo' | 'capillary' | 'custom' | 'ebay' | 'erpstore' | 'ginee' | 'kumu' | 'lazada' | 'mockmarketplace' | 'noon' | 'salla' | 'shopee' | 'shopify' | 'temu' | 'tiktok' | 'tokopedia' | 'wix' | 'woocommerce' | 'zalora' | 'zid' - `offset` integer - `ordering` string - `payment_method` string - `search` string - `warehouse_status` string ## Response `200` List all orders - EnvelopedOrderOpenAPIList - `success` boolean - `data` OrderOpenAPI[], required - `id` integer, required - `marketplace_order_id` string, required - `marketplace_order_ref` string - `shipping_address` CustomAddress, required - `first_name` string, nullable - `last_name` string, nullable - `email` string, nullable - `address_line1` string, nullable - `address_line2` string, nullable - `address_line3` string, nullable - `suburb` string, nullable - `city` string, nullable - `state` string, nullable - `country_code` 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MK' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'AN' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'NO' | 'OM' | 'PK' | 'PW' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'CS' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW', required: * `AF` - AF * `AL` - AL * `DZ` - DZ * `AS` - AS * `AD` - AD * `AO` - AO * `AI` - AI * `AG` - AG * `AR` - AR * `AM` - AM * `AW` - AW * `AU` - AU * `AT` - AT * `AZ` - AZ * `BS` - BS * `BH` - BH * `BD` - BD * `BB` - BB * `BY` - BY * `BE` - BE * `BZ` - BZ * `BJ` - BJ * `BM` - BM * `BT` - BT * `BO` - BO * `BA` - BA * `BW` - BW * `BV` - BV * `BR` - BR * `IO` - IO * `BN` - BN * `BG` - BG * `BF` - BF * `BI` - BI * `KH` - KH * `CM` - CM * `CA` - CA * `CV` - CV * `KY` - KY * `CF` - CF * `TD` - TD * `CL` - CL * `CN` - CN * `CX` - CX * `CC` - CC * `CO` - CO * `KM` - KM * `CG` - CG * `CD` - CD * `CK` - CK * `CR` - CR * `CI` - CI * `HR` - HR * `CU` - CU * `CY` - CY * `CZ` - CZ * `DK` - DK * `DJ` - DJ * `DM` - DM * `DO` - DO * `EC` - EC * `EG` - EG * `SV` - SV * `GQ` - GQ * `ER` - ER * `EE` - EE * `ET` - ET * `FK` - FK * `FO` - FO * `FJ` - FJ * `FI` - FI * `FR` - FR * `GF` - GF * `PF` - PF * `TF` - TF * `GA` - GA * `GM` - GM * `GE` - GE * `DE` - DE * `GH` - GH * `GI` - GI * `GR` - GR * `GL` - GL * `GD` - GD * `GP` - GP * `GU` - GU * `GT` - GT * `GN` - GN * `GW` - GW * `GY` - GY * `HT` - HT * `HM` - HM * `VA` - VA * `HN` - HN * `HK` - HK * `HU` - HU * `IS` - IS * `IN` - IN * `ID` - ID * `IR` - IR * `IQ` - IQ * `IE` - IE * `IL` - IL * `IT` - IT * `JM` - JM * `JP` - JP * `JO` - JO * `KZ` - KZ * `KE` - KE * `KI` - KI * `KP` - KP * `KR` - KR * `KW` - KW * `KG` - KG * `LA` - LA * `LV` - LV * `LB` - LB * `LS` - LS * `LR` - LR * `LY` - LY * `LI` - LI * `LT` - LT * `LU` - LU * `MO` - MO * `MK` - MK * `MG` - MG * `MW` - MW * `MY` - MY * `MV` - MV * `ML` - ML * `MT` - MT * `MH` - MH * `MQ` - MQ * `MR` - MR * `MU` - MU * `YT` - YT * `MX` - MX * `FM` - FM * `MD` - MD * `MC` - MC * `MN` - MN * `MS` - MS * `MA` - MA * `MZ` - MZ * `MM` - MM * `NA` - NA * `NR` - NR * `NP` - NP * `NL` - NL * `AN` - AN * `NC` - NC * `NZ` - NZ * `NI` - NI * `NE` - NE * `NG` - NG * `NU` - NU * `NF` - NF * `MP` - MP * `NO` - NO * `OM` - OM * `PK` - PK * `PW` - PW * `PA` - PA * `PG` - PG * `PY` - PY * `PE` - PE * `PH` - PH * `PN` - PN * `PL` - PL * `PT` - PT * `PR` - PR * `QA` - QA * `RE` - RE * `RO` - RO * `RU` - RU * `RW` - RW * `SH` - SH * `KN` - KN * `LC` - LC * `PM` - PM * `VC` - VC * `WS` - WS * `SM` - SM * `ST` - ST * `SA` - SA * `SN` - SN * `CS` - CS * `SC` - SC * `SL` - SL * `SG` - SG * `SK` - SK * `SI` - SI * `SB` - SB * `SO` - SO * `ZA` - ZA * `ES` - ES * `LK` - LK * `SD` - SD * `SR` - SR * `SJ` - SJ * `SZ` - SZ * `SE` - SE * `CH` - CH * `SY` - SY * `TW` - TW * `TJ` - TJ * `TZ` - TZ * `TH` - TH * `TL` - TL * `TG` - TG * `TK` - TK * `TO` - TO * `TT` - TT * `TN` - TN * `TR` - TR * `TM` - TM * `TC` - TC * `TV` - TV * `UG` - UG * `UA` - UA * `AE` - AE * `GB` - GB * `US` - US * `UM` - UM * `UY` - UY * `UZ` - UZ * `VU` - VU * `VE` - VE * `VN` - VN * `VG` - VG * `VI` - VI * `WF` - WF * `EH` - EH * `YE` - YE * `ZM` - ZM * `ZW` - ZW - `zipcode` string, nullable - `phone` string, nullable - `customs_code` string, nullable: Customs code for the address. This is used to identify the address for customs purposes. - `shipment_type` union - 'Standard' | 'Express' | 'SameDay' | 'NextDay' | 'Scheduled' | 'ReturnDropoff' | 'ReturnStandard' | 'ReturnExpress': * `Standard` - Standard * `Express` - Express * `SameDay` - SameDay * `NextDay` - NextDay * `Scheduled` - Scheduled * `ReturnDropoff` - ReturnDropoff * `ReturnStandard` - ReturnStandard * `ReturnExpress` - ReturnExpress - '' - unknown - `currency` string - `total_price` string, decimal - `total_items` string, required - `marketplace` string, required - `is_cod` boolean, required - `payment_method` string - `marketplace_create_time` string, date-time, nullable - `marketplace_update_time` string, date-time, nullable - `marketplace_status` string - `marketplace_cancellation_reasons` string, required - `wms_cancellation_reasons` string, required - `is_gift` boolean - `delivery_date` string, date-time, nullable - `is_draft` boolean, nullable - `is_edited` string, required - `fulfilment_orders` string, required - `cod_amount` string, decimal - `message` string, required ## Other responses - `400`: Bad Request - Invalid input. - `401`: Unauthorized - Invalid or expired credentials. - `403`: Forbidden - You do not have permission to access this resource. - `404`: Not Found - The requested resource does not exist. - `500`: Internal Server Error - Unexpected error occurred. --- [API](https://skmtc.dev/golocad/apis/locad-api.md) - [All operations](https://skmtc.dev/golocad/apis/locad-api/llms.txt) - [OpenAPI document](https://skmtc.dev/golocad/apis/locad-api/revisions/428200f33a81?raw)