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

# Get Shopify carrier rates

> Shopify calls this endpoint to request an UrbnBox shipping rate. The callback URL is provisioned by UrbnBox with a signed partner-bound token.



## OpenAPI

````yaml /openapi.json post /integrations/shopify/carrier-rates
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/carrier-rates:
    post:
      tags:
        - Shopify
      summary: Get Shopify carrier rates
      description: >-
        Shopify calls this endpoint to request an UrbnBox shipping rate. The
        callback URL is provisioned by UrbnBox with a signed partner-bound
        token.
      operationId: shopifyCarrierRates
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: true
      responses:
        '200':
          description: >-
            A Shopify rates envelope. The rates array is empty when service is
            unavailable.
          content:
            application/json:
              schema:
                type: object
                properties:
                  rates:
                    type: array
                    items:
                      $ref: '#/components/schemas/ShopifyRate'
                required:
                  - rates
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/ServerError'
      security:
        - shopifyCarrierPartner: []
          shopifyCarrierToken: []
components:
  schemas:
    ShopifyRate:
      type: object
      properties:
        service_name:
          type: string
          example: UrbnBox Locker Pickup
        service_code:
          type: string
          const: urbnbox_locker
        total_price:
          type: string
          description: whole KES.
        currency:
          type: string
          const: KES
        min_delivery_date:
          type: string
          format: date-time
        max_delivery_date:
          type: string
          format: date-time
        description:
          type: string
      required:
        - service_name
        - service_code
        - total_price
        - currency
        - min_delivery_date
        - max_delivery_date
        - description
  responses:
    BadRequest:
      description: The request body, date, field, or query parameter is invalid.
      content:
        text/plain:
          schema:
            type: string
    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:
    shopifyCarrierPartner:
      type: apiKey
      in: query
      name: partner
      description: Partner identifier embedded in the callback URL provisioned by UrbnBox.
    shopifyCarrierToken:
      type: apiKey
      in: query
      name: token
      description: >-
        Signed carrier callback token provisioned by UrbnBox. Merchants do not
        configure this value manually.

````

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