> ## Documentation Index > Fetch the complete documentation index at: https://spreecommerce.org/docs/llms.txt > Use this file to discover all available pages before exploring further. # List delivery methods > How this seller's goods can ship: the methods they created themselves, plus any the marketplace shares with its sellers. A shared marketplace method comes back with `editable: false` — it is listed so the seller can see what already ships their goods, and every write against it is a 404. ## OpenAPI ````yaml /api-reference/seller.yaml get /api/v3/seller/delivery_methods openapi: 3.0.3 info: title: Seller API contact: name: Spree Commerce url: https://spreecommerce.org email: hello@spreecommerce.org description: | Spree Seller API v3 - the marketplace seller panel, where a seller runs their own shop inside someone else's marketplace. This is a branch of its own, not a narrowing of the Admin API. Every endpoint is scoped server-side to the seller the request acts as, which is what makes cross-seller access impossible by construction rather than by rule. Sellers never call the Admin API. ## Authentication Sign in at `POST /api/v3/seller/auth/login` and send the returned JWT as `Authorization: Bearer `. The token carries a `seller_api` audience — a token minted for the storefront or the back office is not accepted here, and vice versa. There is deliberately **no secret API key** for this branch: a credential that could act as a seller without a seller signing in is exactly what the separate audience exists to prevent. ### Choosing a seller A user may run more than one seller. Login returns the list; send the chosen seller's ID in the `X-Spree-Seller-Id` header on every authenticated request. The store is derived from the seller — never sent — so no header can widen what a seller reaches. A request that names no seller the caller belongs to is rejected with `403`. ## Response Format All responses are JSON. List endpoints return paginated responses with `data` and `meta` keys. ## Error Handling Errors return a consistent format: ```json { "error": { "code": "validation_error", "message": "Validation failed", "details": { "name": ["can't be blank"] } } } ``` version: v3 servers: - url: http://{defaultHost} variables: defaultHost: default: localhost:3000 security: [] tags: - name: Authentication description: Seller sign-in, token refresh, logout, and invitation acceptance - name: Account description: The signed-in user, the sellers they may act for, and what they may do - name: Countries description: Country and state reference data for the panel's address forms - name: Delivery Methods description: >- The seller's own ways to ship, and the marketplace methods shared with them - name: Delivery Profiles description: >- The marketplace's delivery vocabulary — what kind of goods a product is, which decides how it ships - name: Delivery Zones description: >- The marketplace's destinations, for narrowing where a seller's own method ships - name: Onboarding description: >- The marketplace checklist a seller completes before admission, and what they submit against it - name: Policies description: The seller's own legal documents, as the marketplace asks them to publish - name: Product Types description: The types a seller may list a product against, and what each adds - name: Products description: The seller's own catalog - name: Profile description: >- The seller's own record — presentation, contact details, addresses, and tax registration - name: Stock Locations description: Where the seller keeps stock, and so where their returns are sent - name: Team description: Who runs this seller, and the invitations nobody has accepted yet - name: Uploads description: Presigned direct uploads for the documents onboarding asks for paths: /api/v3/seller/delivery_methods: get: tags: - Delivery Methods summary: List delivery methods description: | How this seller's goods can ship: the methods they created themselves, plus any the marketplace shares with its sellers. A shared marketplace method comes back with `editable: false` — it is listed so the seller can see what already ships their goods, and every write against it is a 404. parameters: - name: X-Spree-Seller-Id in: header required: true schema: type: string - name: page in: query required: false description: Page number schema: type: integer - name: limit in: query required: false description: Records per page (max 100) schema: type: integer responses: '200': description: delivery methods listed content: application/json: example: data: - id: dm_UkLWZg9DAJ name: My courier code: UPS_GROUND_73 estimated_transit_business_days_min: null estimated_transit_business_days_max: null digital: false pickup: false pickup_point: false admin_name: null storefront_visible: true tracking_url: null created_at: '2026-01-15T12:00:00.000Z' updated_at: '2026-01-15T12:00:00.000Z' rules: [] editable: true delivery_profile_id: fp_UkLWZg9DAJ delivery_zone_id: null calculator_type: flat_rate calculator_preferences: amounts: {} amount: '10.0' currency: USD - id: dm_gbHJdmfrXB name: Marketplace post code: UPS_GROUND_74 estimated_transit_business_days_min: null estimated_transit_business_days_max: null digital: false pickup: false pickup_point: false admin_name: null storefront_visible: true tracking_url: null created_at: '2026-01-15T12:00:00.000Z' updated_at: '2026-01-15T12:00:00.000Z' rules: [] editable: false delivery_profile_id: fp_UkLWZg9DAJ delivery_zone_id: null calculator_type: flat_rate calculator_preferences: amounts: {} amount: '10.0' currency: USD meta: page: 1 limit: 25 count: 2 pages: 1 from: 1 to: 2 in: 2 previous: null next: null schema: type: object properties: data: type: array items: $ref: '#/components/schemas/DeliveryMethod' meta: $ref: '#/components/schemas/PaginationMeta' required: - data - meta security: - bearer_auth: [] components: schemas: DeliveryMethod: type: object properties: id: type: string name: type: string code: type: string nullable: true estimated_transit_business_days_min: type: number nullable: true estimated_transit_business_days_max: type: number nullable: true digital: type: boolean pickup: type: boolean pickup_point: type: boolean admin_name: type: string nullable: true storefront_visible: type: boolean tracking_url: type: string nullable: true created_at: type: string updated_at: type: string rules: type: array items: $ref: '#/components/schemas/DeliveryMethodRule' editable: type: boolean delivery_profile_id: type: string nullable: true delivery_zone_id: type: string nullable: true calculator_type: type: string nullable: true calculator_preferences: type: object nullable: true required: - id - name - code - estimated_transit_business_days_min - estimated_transit_business_days_max - digital - pickup - pickup_point - admin_name - storefront_visible - tracking_url - created_at - updated_at - rules - editable - delivery_profile_id - delivery_zone_id - calculator_type - calculator_preferences x-typelizer: true PaginationMeta: type: object properties: page: type: integer example: 1 limit: type: integer example: 25 count: type: integer example: 100 description: Total number of records pages: type: integer example: 4 description: Total number of pages from: type: integer example: 1 description: Index of first record on this page to: type: integer example: 25 description: Index of last record on this page in: type: integer example: 25 description: Number of records on this page previous: type: integer nullable: true example: null description: Previous page number next: type: integer nullable: true example: 2 description: Next page number required: - page - limit - count - pages - from - to - in DeliveryMethodRule: type: object properties: id: type: string active: type: boolean type: type: string description: >- Rule type. Built-in: item_total_rule, weight_rule, excluded_products_rule, channel_rule, volume_rule, company_rule. Extensions may register more. preferences: type: object preference_schema: type: object required: - id - active - type - preferences - preference_schema x-typelizer: true securitySchemes: bearer_auth: type: http scheme: bearer bearerFormat: JWT description: JWT token for an authenticated seller session (`seller_api` audience) ````