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

# Place a checkout-mode shop order

> Creates an order through the canonical transactional path (idempotent, snapshotted, outbox-emitting), attributed to the house reseller team. Re-checks coverage against the submitted address; unauthenticated.



## OpenAPI

````yaml /openapi/openapi-public.json post /public/shop/orders
openapi: 3.0.0
info:
  title: OfferGrid API
  description: >-
    **Public API** - Unauthenticated endpoints with no API key required.


    These power two public, no-login surfaces:

    - **Shareable links** (`/public/links/*`) - a reseller-branded landing page
    for a specific set of offers, used to collect an order from an end customer.

    - **Consumer shop** (`/public/shop/*`) - the offergrid.io/shop storefront,
    where consumers browse real offers by ZIP code and either check out directly
    or are redirected to a provider's own site.


    All endpoints here are rate-limited and validate/re-check coverage
    server-side; none require the `x-api-key` header used by the Provider and
    Reseller APIs.
  version: '1.0'
  contact: {}
servers:
  - url: https://api.offergrid.io
    description: Production
security: []
tags:
  - name: public
    description: >-
      Public: Unauthenticated endpoints for shareable links and the /shop
      storefront
paths:
  /public/shop/orders:
    post:
      tags:
        - public
      summary: Place a checkout-mode shop order
      description: >-
        Creates an order through the canonical transactional path (idempotent,
        snapshotted, outbox-emitting), attributed to the house reseller team.
        Re-checks coverage against the submitted address; unauthenticated.
      operationId: PublicShopController_createOrder
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateShopOrderDto'
      responses:
        '201':
          description: Order created (or the original, on idempotent replay)
        '422':
          description: One or more offers are no longer available at this address
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Unexpected server error. Safe to retry idempotent requests.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: Shop checkout is not configured (house reseller team unset)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    CreateShopOrderDto:
      type: object
      properties:
        items:
          description: Offers to order — checkout-mode offers only, one per category
          type: array
          items:
            $ref: '#/components/schemas/ShopOrderItemDto'
        serviceAddress:
          description: Service address for installation
          allOf:
            - $ref: '#/components/schemas/ShopServiceAddressDto'
        customerInfo:
          description: Shopper contact information
          allOf:
            - $ref: '#/components/schemas/ShopCustomerInfoDto'
        notes:
          type: string
          description: Additional notes from the shopper
        idempotencyKey:
          type: string
          description: >-
            Client-generated key for this checkout attempt. A repeat submission
            with the same key (network retry, double-click on Submit) returns
            the original order instead of creating a duplicate.
          example: a1b2c3d4-checkout-attempt
        sessionId:
          type: string
          description: >-
            Anonymous client-generated session id, so the checkout-mode click
            this order completes can be tied to the same funnel as its lead_gen
            counterpart.
          example: a1b2c3d4-shopper-session
      required:
        - items
        - serviceAddress
        - customerInfo
      title: Create Shop Order
    ErrorResponse:
      type: object
      title: Error
      description: Standard error envelope returned by every 4xx and 5xx response.
      required:
        - statusCode
        - message
      properties:
        statusCode:
          type: integer
          description: HTTP status code, repeated in the body.
          example: 404
        message:
          type: string
          description: Human-readable explanation of what went wrong.
          example: Offer not found
        error:
          type: string
          description: Short, stable name for the status code.
          example: Not Found
    ShopOrderItemDto:
      type: object
      properties:
        offerId:
          type: string
          description: ID of the consumer-enabled offer to order
        metadata:
          type: object
          description: >-
            Per-item metadata stored on the resulting OrderItem — for
            electricity offers, carry enrollment details here (mirrors the
            reseller checkout wizard).
          example:
            enrollment:
              enrollmentType: switch
              esid: '10443720000000000'
              requestedStartDate: '2026-07-15'
      required:
        - offerId
      title: Shop Order Item
    ShopServiceAddressDto:
      type: object
      properties:
        street:
          type: string
          example: 123 Main St
        unit:
          type: string
          example: Unit 4B
        city:
          type: string
          example: Austin
        state:
          type: string
          example: TX
        zipCode:
          type: string
          example: '78701'
        country:
          type: string
          example: US
          default: US
      required:
        - street
        - city
        - state
        - zipCode
      title: Shop Service Address
    ShopCustomerInfoDto:
      type: object
      properties:
        firstName:
          type: string
          example: Jane
        lastName:
          type: string
          example: Doe
        fullName:
          type: string
          example: Jane Doe
          description: >-
            Legacy single-field name — prefer firstName + lastName. Required
            only when both are absent; split on the last space when used.
        email:
          type: string
          example: jane@example.com
        phone:
          type: string
          example: 555-123-4567
      required:
        - email
        - phone
      title: Shop Customer Info

````