--- updatedAt: 2026-06-18T06:23:52.000Z agentTools: projectIndex: https://developers.easyship.com/llms.txt --- # List all Products Retrieve a list of products available with your account. Required authorization scope: `public.product:read` # OpenAPI definition ```json { "openapi": "3.0.3", "info": { "title": "Easyship Public API", "version": "v2024-09", "description": "## Powerful Shipping API for Ecommerce\nEasyship provides a powerful shipping API for you to add hassle free worldwide shipping options to your website and end to end shipping functionality to your warehouse, ERP or platform.\n\n### Craft an amazing checkout experience\nProvide instant access to heavily discounted shipping with a single integration. Let end customers choose their preferred shipping method and cost, all within your own UI. Once they've selected and paid, confirm the shipment and all costs are guaranteed by us.\n\n### Write less code, have more options\nYou don’t need to be a shipping expert. We continuously add new shipping solutions to our platform to provide better pricing and service to our users. You don’t need to open direct accounts or write multiple integrations, once we’ve added them, they’re available to you instantly.\n\n### Streamline your processes\nInteract with the Easyship platform from any interface. Whether it’s your ecommerce platform, warehouse/wms, ERP or order management system, you can get rates, create shipments, download labels and track deliveries, without leaving your main business system.", "termsOfService": "https://www.easyship.com/legal/terms/overview", "contact": { "name": "Easyship Support", "url": "https://www.easyship.com/contact" } }, "externalDocs": { "description": "Find out more about Easyship API", "url": "https://developers.easyship.com/" }, "tags": [ { "name": "Products" } ], "paths": { "/2024-09/products": { "get": { "summary": "List all Products", "tags": [ "Products" ], "operationId": "products_index", "description": "Retrieve a list of products available with your account.\n\nRequired authorization scope: `public.product:read`\n", "security": [ { "Bearer": [] } ], "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "required": false, "description": "Page number to fetch, default: `1`", "example": 1 }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "required": false, "description": "Number of records per page to fetch, default: `20`", "example": 10 }, { "name": "sku", "in": "query", "required": false, "description": "Filter records by SKU", "example": "SKU-7773839", "schema": { "type": "string" } }, { "name": "category", "in": "query", "required": false, "description": "Filter records by product category", "example": "Health", "schema": { "type": "string" } } ], "responses": { "200": { "description": "list of products", "content": { "application/json": { "examples": { "default": { "value": { "products": [ { "id": "01563646-58c1-4607-8fe0-cae3e33c0003", "comments": "comments", "contains_battery_pi966": null, "contains_battery_pi967": null, "contains_liquids": null, "cost_price": null, "cost_price_currency": null, "created_at": "2022-02-22T12:21:00Z", "height": 5, "hs_code": "33049930", "identifier": "SKU-00000003", "image_url": null, "input_type": "api", "item_category": { "id": 7, "name": "Health & Beauty" }, "length": 12, "name": "Lotion", "origin_country_alpha2": "DE", "pick_location": "Guardian", "platform_product_id": null, "manufacturer_part_number": null, "global_trade_item_number": null, "selling_price": null, "selling_price_currency": null, "store_id": "01563646-58c1-4607-8fe0-cae3e33c0001", "updated_at": "2022-02-22T12:21:00Z", "weight": 0.25, "width": 10 } ], "meta": { "pagination": { "page": 1, "next": null, "count": 1 }, "request_id": "01563646-58c1-4607-8fe0-cae3e92c4477" } }, "summary": "list of products" } }, "schema": { "$ref": "#/components/schemas/product_list" } } } } } } } }, "servers": [ { "url": "https://public-api.easyship.com", "description": "Production" } ], "components": { "securitySchemes": { "Bearer": { "description": "Bearer Token necessary to use API", "type": "http", "scheme": "bearer", "bearerFormat": "token" } }, "schemas": { "product_list": { "type": "object", "description": "List of products", "additionalProperties": false, "properties": { "products": { "type": "array", "items": { "$ref": "#/components/schemas/Product" } }, "meta": { "$ref": "#/components/schemas/MetaWithPagination" } } }, "Pagination": { "type": "object", "description": "Pagination", "additionalProperties": false, "properties": { "next": { "type": "integer", "nullable": true }, "count": { "type": "integer", "description": "The total number of items. The `null` value is used with countless pagination (used for faster response on large datasets, like shipments).", "nullable": true }, "page": { "type": "integer", "description": "Current page" } } }, "Meta": { "type": "object", "properties": { "request_id": { "type": "string", "description": "An unique ID represent the request." } } }, "MetaWithPagination": { "allOf": [ { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/Pagination" } } }, { "$ref": "#/components/schemas/Meta" } ] }, "CountryAlpha2Nullable": { "type": "string", "description": "Country Code in Alpha-2 format (ISO 3166-1)", "enum": [ "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", null ], "nullable": true }, "CurrencyNullable": { "type": "string", "nullable": true, "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LVL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SKK", "SLL", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VES", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMW", "BTC", "JEP", "EEK", "GHC", "MTL", "TMM", "YEN", "ZWD", "ZWL", "ZWN", "ZWR", null ], "example": "USD", "description": "ISO-4217 three-letter alphabetic currency code (e.g. USD, EUR, GBP)" }, "Product": { "type": "object", "description": "Product", "additionalProperties": false, "properties": { "id": { "type": "string", "format": "uuid", "description": "Product ID" }, "store_id": { "type": "string", "format": "uuid", "nullable": true, "description": "Store ID" }, "name": { "type": "string", "description": "Human-readable name of the product." }, "item_category": { "type": "object", "additionalProperties": false, "nullable": true, "properties": { "id": { "type": "integer", "description": "Item Category ID" }, "name": { "type": "string", "description": "Item Category Name" } } }, "comments": { "type": "string", "nullable": true }, "input_type": { "type": "string", "enum": [ "manual_input", "product_sync", "api", "api_upload", "csv_upload" ] }, "identifier": { "type": "string", "description": "Stock Keeping Unit (SKU). Your internal product identifier, typically unique within your store for inventory management and tracking." }, "length": { "type": "number", "format": "double", "nullable": true, "description": "Product length in cm (centimeters)." }, "width": { "type": "number", "format": "double", "nullable": true, "description": "Product width in cm (centimeters)." }, "height": { "type": "number", "format": "double", "nullable": true, "description": "Product height in cm (centimeters)." }, "weight": { "type": "number", "format": "double", "nullable": true, "description": "Product weight in kg (kilograms)." }, "platform_product_id": { "type": "string", "nullable": true, "description": "Platform Product ID (PPID). Unique identifier from your store platform (e.g. Shopify variant ID, WooCommerce product ID). Used to link shipment items to product catalog entries for auto-population of product attributes." }, "manufacturer_part_number": { "type": "string", "nullable": true, "description": "Manufacturer Part Number (MPN). The manufacturer's internal code or part number for the product. Useful for wholesale and B2B operations to identify products by their source." }, "global_trade_item_number": { "type": "string", "nullable": true, "description": "Global Trade Item Number (GTIN). Internationally recognized unique identifier for trade items, including UPC (US/Canada), EAN (Europe), JAN (Japan), and ISBN (books). Used by retailers and carriers for product identification and inventory tracking." }, "cost_price": { "type": "number", "format": "double", "nullable": true }, "cost_price_currency": { "$ref": "#/components/schemas/CurrencyNullable" }, "selling_price": { "type": "number", "format": "double", "nullable": true }, "selling_price_currency": { "$ref": "#/components/schemas/CurrencyNullable" }, "image_url": { "type": "string", "nullable": true }, "pick_location": { "type": "string", "nullable": true }, "origin_country_alpha2": { "allOf": [ { "$ref": "#/components/schemas/CountryAlpha2Nullable" }, { "description": "Country where the product is manufactured. Country Code in Alpha-2 format (ISO 3166-1)" } ] }, "hs_code": { "type": "string", "nullable": true }, "contains_liquids": { "type": "boolean", "nullable": true }, "contains_battery_pi966": { "type": "boolean", "nullable": true }, "contains_battery_pi967": { "type": "boolean", "nullable": true }, "cpsc_status": { "type": "string", "enum": [ "not_applicable", "absent", "partial", "complete" ], "description": "Computed CPSC compliance completeness. not_applicable if the product isn't CPSC-regulated, absent if no compliance data has been entered, partial if some required fields for the chosen path are missing, complete if all required fields are present." }, "cpsc_compliance": { "$ref": "#/components/schemas/CpscCompliance" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } } }, "CpscCompliance": { "type": "object", "additionalProperties": false, "nullable": true, "description": "CPSC (Consumer Product Safety Commission) compliance data stored on this product. Required for certain regulated products (e.g. children's products, electronics, furniture, toys) shipped to the US from 8 July 2026.\n\n**Note:** fields are scoped to `coc_type` -- only fields relevant to the current path are ever non-null; see `coc_type`'s description below.\n", "properties": { "id": { "type": "string", "format": "uuid", "description": "CPSC compliance record ID" }, "coc_type": { "type": "string", "enum": [ "registered", "unregistered", "exempted" ], "nullable": true, "description": "Defines the Certificate of Conformity (CoC) path. Your selection determines which fields are active (fields outside the selected group evaluate to `null`):\n - `registered`: certifier_identifier, version_identifier, product_identifier_type\n - `unregistered`: citation_code, certifier_identity, manufacturing_detail, manufacturing_date, testing_detail, laboratory, records_custodian, product_identifier_type\n - `exempted`: disclaim_code\n\n**Note on updates:** Changing the `coc_type` automatically clears all fields from the previous path. You must send the fields for the new path in the same request.\n" }, "certifier_identifier": { "type": "string", "nullable": true, "description": "CPSC Product Registry account ID. Applies to the registered path." }, "version_identifier": { "type": "string", "nullable": true, "description": "CPSC Product Registry version ID. Applies to the registered path." }, "citation_code": { "type": "string", "nullable": true, "description": "Applicable CPSC rule citation, e.g. \"16 CFR 1500.3\". Applies to the unregistered path." }, "certifier_identity": { "type": "string", "nullable": true, "description": "Name and contact of the certifying entity. Applies to the unregistered path." }, "manufacturing_detail": { "type": "string", "nullable": true, "description": "Place of manufacture. Applies to the unregistered path." }, "manufacturing_date": { "type": "string", "format": "date", "nullable": true, "description": "Date of manufacture. Applies to the unregistered path." }, "testing_detail": { "type": "string", "nullable": true, "description": "Description of testing performed. Applies to the unregistered path." }, "laboratory": { "type": "string", "nullable": true, "description": "Testing laboratory name. Applies to the unregistered path." }, "records_custodian": { "type": "string", "nullable": true, "description": "Records-keeper contact. Applies to the unregistered path." }, "product_identifier_type": { "type": "string", "enum": [ "sku", "gtin" ], "nullable": true, "description": "Whether product_identifier is a SKU or a GTIN. Applies to the registered and unregistered paths." }, "product_identifier": { "type": "string", "nullable": true, "description": "Read-only. The product's SKU or GTIN value, derived from the product record according to product_identifier_type." }, "disclaim_code": { "type": "string", "nullable": true, "description": "Exemption/disclaim basis code. Applies to the exempted path." } } } } } } ```