--- title: "List all Courier Services" method: GET path: "/2024-09/courier_services" tags: ["Courier Services"] --- # List all Courier Services `GET /2024-09/courier_services` Retrieve a list of active courier services available with your account. Required authorization scope: `public.courier_service:read` ## Query parameters - `page` integer - `per_page` integer - `sort_by` 'origin_country_id' | 'courier_name' | 'created_at' - `sort_direction` 'ASC' | 'DESC' - `country_alpha2` string[] - `umbrella_name` string - `customer_reference_id` string - `accepts` string[] - `supported_incoterms` string[] - `international` boolean - `domestic` boolean ## Response `200` list of courier services - CourierServiceList — List of couriers service - `courier_services` CourierService[] - `id` string, uuid — ID - `name` string — If the courier service is connected through your own courier account, this will be "{nickname} - {official_name}". If the courier service is provided by Easyship, this will be the official name of the courier service. - `umbrella_name` string — Human-readable name for the courier company that offers this service. - `official_name` string — Official name of the courier service. - `nickname` string, nullable — Nickname you set when creating/updating the courier service. Only applicable for LYOC services. - `service_name` string — Service that offered by the courier company. - `logo_url` string, nullable — Logo of the courier. Deprecated in favor of `courier_logo_url`. - `country_alpha2` 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AN' | 'AO' | 'AQ' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PS' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VI' | 'VN' | 'VU' | 'WF' | 'WS' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' — Country Code in Alpha-2 format (ISO 3166-1) - `active` boolean, nullable — Whether the courier is active or not. - `restricted_to_origin_states` string[], nullable — List of origin states that the service is available for (US only). - `restricted_to_destination_states` string[], nullable — List of destination states that the service is available for (US only). - `supported_incoterms` string[] — Terms of Sale DDP: Seller pays all import duties/taxes. DDU: Buyer pays all import duties/taxes. - `ioss_support` 'supported_mandatory' | 'supported_optional' | 'not_supported' | 'null', nullable - `customer_reference_id` string, nullable — An identifier for the customer who owns the account. Available only for selected customers. - `accepts_outbounds` boolean — Whether the courier can be used to generate outbound labels. - `accepts_prepaid_returns` boolean — Returns `true` if returns are billed upon label generation. - `accepts_pay_on_scan_returns` boolean — Returns `true` if returns are billed upon label scan. - `domestic` boolean — Returns `true` if the courier service is a domestic service. Both `domestic` and `international` can be `true` at the same time. - `international` boolean — Returns `true` if the courier service is an international service. Both `domestic` and `international` can be `true` at the same time. - `courier_id` string, uuid — The Courier ID is associated with this service. - `courier_logo_url` string — The URL of the Courier logo. - `easyship_courier_service` boolean — Whether the Courier Service belongs to Easyship or not. - `accepts` object — Acceptance criteria for the courier. - `outbounds` boolean — Whether the courier can be used to generate outbound labels. - `prepaid_returns` boolean — Returns `true` if returns are billed upon label generation. - `pay_on_scan_returns` boolean — Returns `true` if returns are billed upon label scan. - `pi965_batteries` boolean — Returns `true` if courier accepts battery (pi965). - `pi966_batteries` boolean — Returns `true` if courier accepts battery (pi966). - `pi967_batteries` boolean — Returns `true` if courier accepts battery (pi967). - `liquids` boolean — Returns `true` if courier accepts liquids. - `specific_dangerous_goods` boolean — Returns `true` if courier accepts other dangerous goods that are not batteries (pi966, pi967, or pi968). - `documents` boolean — Returns `true` if courier accepts documents. - `parcels` boolean — Returns `true` if courier accepts parcels. - `available_handover_options` string[] — A list of one or more of `dropoff`, `free_pickup`, and `paid_pickup` - `tracking_rating` -1 | 0 | 1 | 2 | 3 — Quality of tracking information provided by the courier -1: No tracking number 0: Limited 1: Basic 2: Regular 3: Excellent - `meta` MetaWithPagination - `pagination` Pagination — Pagination - `next` integer, nullable - `count` integer, nullable — The total number of items. The `null` value is used with countless pagination (used for faster response on large datasets, like shipments). - `page` integer — Current page - `request_id` string — An unique ID represent the request. --- [API](https://skmtc.net/easyship/apis/easyship-public-api.md) · [All operations](https://skmtc.net/easyship/apis/easyship-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/easyship/easyship-public-api/revisions/71d737a5fcbf/schema)