> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sellfern.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Retrieve an order

> Retrieves one order and its items. Orders outside the authenticated organization are returned as not found. The public schema is curated for fulfillment operations and omits customer email, payment method, net/profitability, refund amount, and item cost fields.

Scope notes: Requires order read scope and authenticated organization isolation.

Read-only endpoint.



## OpenAPI

````yaml /public_openapi_v1.json get /orders/{id}
openapi: 3.0.0
info:
  title: Sellfern Public API
  version: 1.0.0
  description: OpenAPI spec for Sellfern Public V1 developer docs.
  contact:
    name: Sellfern Support
    email: support@sellfern.com
servers:
  - url: https://api.sellfern.com
    description: Production API
security:
  - ApiKeyAuth: []
tags:
  - name: Organizations And Stores
  - name: Orders
  - name: Order Items
  - name: Products And Catalog
  - name: Webhooks
paths:
  /orders/{id}:
    get:
      tags:
        - Orders
      summary: Retrieve an order
      description: >-
        Retrieves one order and its items. Orders outside the authenticated
        organization are returned as not found. The public schema is curated for
        fulfillment operations and omits customer email, payment method,
        net/profitability, refund amount, and item cost fields.


        Scope notes: Requires order read scope and authenticated organization
        isolation.


        Read-only endpoint.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
            minimum: 1
          description: Order ID.
      responses:
        '200':
          description: Order returned successfully.
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    $ref: '#/components/schemas/PublicOrder'
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
        '400':
          $ref: '#/components/responses/ValidationError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/ForbiddenError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/RateLimitedError'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    PublicOrder:
      type: object
      properties:
        id:
          type: integer
          example: 1234567890
        storeName:
          type: string
          example: My Etsy Store
        date:
          type: string
          format: date-time
        currency:
          type: string
          example: USD
        totalAmount:
          type: number
          description: >-
            Order total shown for operational reconciliation; profitability and
            payout fields are excluded.
        subtotal:
          type: number
        tax:
          type: number
        shippingCost:
          type: number
        discount:
          type: number
        customerName:
          type: string
          nullable: true
        customerAddress:
          type: string
          nullable: true
        shipAddress1:
          type: string
          nullable: true
        shipAddress2:
          type: string
          nullable: true
        shipCity:
          type: string
          nullable: true
        shipState:
          type: string
          nullable: true
        shipZipcode:
          type: string
          nullable: true
        shipCountry:
          type: string
          nullable: true
        isGift:
          type: boolean
          nullable: true
        isRefunded:
          type: boolean
          nullable: true
        isCaseClosed:
          type: boolean
          nullable: true
        isLost:
          type: boolean
          nullable: true
        requiresAudit:
          type: boolean
          nullable: true
        createdAt:
          type: string
          format: date-time
          nullable: true
        updatedAt:
          type: string
          format: date-time
          nullable: true
        items:
          type: array
          items:
            $ref: '#/components/schemas/PublicOrderItem'
    ResponseMeta:
      type: object
      properties:
        request_id:
          type: string
          description: Request identifier, when available.
    PublicOrderItem:
      type: object
      properties:
        id:
          type: string
          example: '987654321'
        orderId:
          type: string
          example: '1234567890'
        customOrderId:
          type: string
          nullable: true
        name:
          type: string
        sku:
          type: string
          nullable: true
        customSku:
          type: string
          nullable: true
        spu:
          type: string
          nullable: true
        quantity:
          type: integer
          example: 1
        price:
          type: number
        status:
          type: string
          nullable: true
          example: In Production
        assignedSupplier:
          type: string
          nullable: true
        subSupplier:
          type: string
          nullable: true
        material:
          type: string
          nullable: true
        materialId:
          type: string
          nullable: true
        designUrl:
          type: string
          nullable: true
        trackingCode:
          type: string
          nullable: true
        carrier:
          type: string
          nullable: true
        style:
          type: string
          nullable: true
        type:
          type: string
          nullable: true
        size:
          type: string
          nullable: true
        color:
          type: string
          nullable: true
        variations:
          type: string
          nullable: true
        personalization:
          type: string
          nullable: true
        comment:
          type: string
          nullable: true
        idService:
          type: string
          nullable: true
        phone:
          type: string
          nullable: true
        orderDate:
          type: string
          nullable: true
        storeName:
          type: string
          nullable: true
        isGift:
          type: boolean
          nullable: true
        customerName:
          type: string
          nullable: true
        customerAddress:
          type: string
          nullable: true
        shipName:
          type: string
          nullable: true
        shipAddress1:
          type: string
          nullable: true
        shipAddress2:
          type: string
          nullable: true
        shipCity:
          type: string
          nullable: true
        shipState:
          type: string
          nullable: true
        shipZipcode:
          type: string
          nullable: true
        shipCountry:
          type: string
          nullable: true
        vatIossNumber:
          type: string
          nullable: true
  responses:
    ValidationError:
      description: Request validation failed.
      content:
        application/json:
          schema:
            type: object
            required:
              - success
              - error
            properties:
              success:
                type: boolean
                example: false
              error:
                type: object
                required:
                  - code
                  - message
                properties:
                  code:
                    type: string
                    example: validation_error
                  message:
                    type: string
                    example: Request validation failed.
              meta:
                $ref: '#/components/schemas/ResponseMeta'
    UnauthorizedError:
      description: Missing or invalid API key.
      content:
        application/json:
          schema:
            type: object
            required:
              - success
              - error
            properties:
              success:
                type: boolean
                example: false
              error:
                type: object
                required:
                  - code
                  - message
                properties:
                  code:
                    type: string
                    example: unauthorized
                  message:
                    type: string
                    example: Missing or invalid API key.
              meta:
                $ref: '#/components/schemas/ResponseMeta'
    ForbiddenError:
      description: API key lacks the required scope.
      content:
        application/json:
          schema:
            type: object
            required:
              - success
              - error
            properties:
              success:
                type: boolean
                example: false
              error:
                type: object
                required:
                  - code
                  - message
                properties:
                  code:
                    type: string
                    example: missing_scope
                  message:
                    type: string
                    example: Missing required scope.
              meta:
                $ref: '#/components/schemas/ResponseMeta'
    NotFoundError:
      description: Resource not found or outside the authenticated organization.
      content:
        application/json:
          schema:
            type: object
            required:
              - success
              - error
            properties:
              success:
                type: boolean
                example: false
              error:
                type: object
                required:
                  - code
                  - message
                properties:
                  code:
                    type: string
                    example: not_found
                  message:
                    type: string
                    example: Resource not found.
              meta:
                $ref: '#/components/schemas/ResponseMeta'
    RateLimitedError:
      description: Rate limit exceeded.
      content:
        application/json:
          schema:
            type: object
            required:
              - success
              - error
            properties:
              success:
                type: boolean
                example: false
              error:
                type: object
                required:
                  - code
                  - message
                properties:
                  code:
                    type: string
                    example: rate_limited
                  message:
                    type: string
                    example: Rate limit exceeded.
              meta:
                $ref: '#/components/schemas/ResponseMeta'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Sellfern public API key scoped to the authenticated organization. Do not
        use user JWTs for public integrations.

````