> ## 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.

# Retrieve a checkout session

> Returns a checkout session owned by the authenticated partner.



## OpenAPI

````yaml /openapi.json get /api/partner/v1/checkout-sessions/{id}
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:
  /api/partner/v1/checkout-sessions/{id}:
    get:
      tags:
        - Checkout sessions
      summary: Retrieve a checkout session
      description: Returns a checkout session owned by the authenticated partner.
      operationId: getCheckoutSession
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Checkout session details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckoutSession'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/ServerError'
      security:
        - partnerKey: []
components:
  schemas:
    CheckoutSession:
      type: object
      properties:
        ID:
          type: string
        PartnerID:
          type: string
        ExternalOrderID:
          type:
            - string
            - 'null'
        SpaceID:
          type:
            - string
            - 'null'
        ClientName:
          type:
            - string
            - 'null'
        Phone:
          type:
            - string
            - 'null'
        StartsAt:
          type:
            - string
            - 'null'
          format: date-time
        EndsAt:
          type:
            - string
            - 'null'
          format: date-time
        AmountCents:
          type:
            - integer
            - 'null'
          format: int64
        Status:
          type: string
        IdempotencyKey:
          type:
            - string
            - 'null'
        CreatedAt:
          type: string
          format: date-time
        UpdatedAt:
          type: string
          format: date-time
        ExpiresAt:
          type: string
          format: date-time
      required:
        - ID
        - PartnerID
        - Status
        - CreatedAt
        - UpdatedAt
        - ExpiresAt
  responses:
    Unauthorized:
      description: The credential is missing, invalid, or inactive.
      content:
        text/plain:
          schema:
            type: string
    Forbidden:
      description: The credential is not authorized for this operation.
      content:
        text/plain:
          schema:
            type: string
    NotFound:
      description: The resource does not exist for the authenticated partner.
      content:
        text/plain:
          schema:
            type: string
    ServerError:
      description: UrbnBox could not complete the request.
      content:
        text/plain:
          schema:
            type: string
  securitySchemes:
    partnerKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: Partner key. Shipment creation requires a secret key.

````

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