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

# Process a paid Shopify order

> Creates an UrbnBox shipment for a connected Shopify store when a paid order selected UrbnBox delivery.



## OpenAPI

````yaml /openapi.json post /integrations/shopify/orders-paid
openapi: 3.1.0
info:
  title: UrbnBox integration API
  version: 1.0.0
  description: >-
    Create and track delivery orders, send parcels between pickup points, and
    connect Shopify.
servers:
  - url: https://portal.urbnbox.io
    description: UrbnBox production and test-key server
security: []
tags:
  - name: Shipments
    description: Quote, create, and retrieve pickup-point shipments.
  - name: Checkout sessions
    description: Hold lockers for partner checkout sessions.
  - name: Public bookings
    description: Create browser-based locker bookings.
  - name: Store discovery
    description: Find active UrbnBox stores.
  - name: Shopify
    description: Callbacks called by Shopify.
  - name: Vendor API
    description: >-
      Vendor-authenticated endpoints for delivery orders, pickup-point shipments
      and webhooks. All require an X-API-Key header with a vendor key.
paths:
  /integrations/shopify/orders-paid:
    post:
      tags:
        - Shopify
      summary: Process a paid Shopify order
      description: >-
        Creates an UrbnBox shipment for a connected Shopify store when a paid
        order selected UrbnBox delivery.
      operationId: shopifyOrderPaid
      parameters:
        - name: X-Shopify-Shop-Domain
          in: header
          required: true
          schema:
            type: string
            example: example-store.myshopify.com
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
      responses:
        '200':
          description: >-
            Acknowledgement. Successful creation includes a shipment ID and
            tracking URL.
          content:
            application/json:
              schema:
                type: object
                properties:
                  shipment_id:
                    type: string
                  tracking_url:
                    type: string
                    format: uri
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/ServerError'
      security:
        - shopifyHmac: []
components:
  responses:
    Unauthorized:
      description: The credential is missing, invalid, or inactive.
      content:
        text/plain:
          schema:
            type: string
    ServerError:
      description: UrbnBox could not complete the request.
      content:
        text/plain:
          schema:
            type: string
  securitySchemes:
    shopifyHmac:
      type: apiKey
      in: header
      name: X-Shopify-Hmac-Sha256
      description: Base64-encoded HMAC-SHA256 signature generated by Shopify.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.