swagger: '2.0'
info:
  x-logo:
    url: https://storage.googleapis.com/boxc_cdn/public/boxc-logo.png
    altText: BoxC
  title: BoxC CalculateDuty Warehouses API
  version: '1.123'
  description: 'A simple but powerful logistics API that drives international ecommerce by utilizing a single integration with access to dozens of carriers and global markets. BoxC can complete every leg or only select steps of a shipment''s journey on your behalf with our routing engine.

    '
schemes:
- https
tags:
- name: Warehouses
  x-displayName: Warehouses
  description: 'The Warehouses resource allows you to retrieve location and identity information for a single warehouse or all warehouses. You should query this endpoint to retrieve an active list of fulfillment warehouses that customers can send their products to restock their inventory. The ```warehouse.id``` is used for selecting the warehouse while creating an inbound shipment or an order.

    '
paths:
  /warehouses:
    get:
      tags:
      - Warehouses
      summary: GET /warehouses
      description: Retrieves a list of warehouses.
      operationId: getWarehouses
      consumes:
      - application/json
      produces:
      - application/json
      security:
      - JWT: []
      x-codeSamples:
      - lang: cURL
        label: cURL
        source: "curl -H \"Authorization: Bearer <YOUR TOKEN>\" \\\n  -H \"Accept: application/json\" \\\n  https://api.boxc.com/v1/warehouses\n"
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  warehouses:
                    type: array
                    title: Warehouse
                    items:
                      $ref: '#/definitions/WarehouseStorage'
        '401':
          $ref: '#/definitions/Unauthorized'
        '403':
          $ref: '#/definitions/Forbidden'
        '429':
          $ref: '#/definitions/RateLimit'
  /warehouses/{id}:
    get:
      tags:
      - Warehouses
      summary: GET /warehouses/{id}
      description: Retrieves a warehouse.
      operationId: getWarehousesById
      consumes:
      - application/json
      produces:
      - application/json
      security:
      - JWT: []
      parameters:
      - name: id
        in: path
        description: The warehouse ID
        required: true
        type: string
        minLength: 8
        maxLength: 8
      x-codeSamples:
      - lang: cURL
        label: cURL
        source: "curl -H \"Authorization: Bearer <YOUR TOKEN>\" \\\n  -H \"Accept: application/json\" \\\n  https://api.boxc.com/v1/warehouses/{id}\n"
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  warehouse:
                    $ref: '#/definitions/Warehouse'
        '401':
          $ref: '#/definitions/Unauthorized'
        '403':
          $ref: '#/definitions/Forbidden'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/definitions/NotFound'
              examples:
                notFound:
                  summary: Not Found
                  description: Warehouse not found
                  value:
                    code: 1360
                    message: Warehouse not found
                    errors:
                    - Warehouse not found
        '429':
          $ref: '#/definitions/RateLimit'
definitions:
  warehouse-storage:
    allOf:
    - type: object
      $ref: '#/definitions/Warehouse'
    - type: object
      properties:
        storage:
          description: Information about the storage costs for the warehouse.
          type: object
          properties:
            free_days:
              type: integer
              description: The number of days a product will be stored for free.
              example: 30
              readOnly: true
            large_cost:
              type: decimal
              description: The price per cubic meter for storing a large sized product.
              example: 30
              readOnly: true
            medium_cost:
              type: decimal
              description: The price for storing one unit of a medium sized product.
              example: 0.03
              readOnly: true
            small_cost:
              type: decimal
              description: The price for storing one unit of a small sized product.
              example: 0.01
              readOnly: true
  warehouse:
    type: object
    description: Information about the warehouse the inbound shipment or is being sent to or a return was processed at. Only the ```id``` is required when creating an inbound shipment. View the [Warehouses resource](/#tag/Warehouses) for a list.
    properties:
      address:
        description: The warehouse address with newlines (\n).
        type: string
        example: 'Unit 5b, 102 Jinfanghua Ecommerce District

          Shenzhen

          GD 518000

          China'
        readOnly: true
      country:
        description: The country where the warehouse resides.
        type: string
        example: HK
        readOnly: true
      entry_point:
        description: The [Entry Point](#tag/EntryPoints) id associated to the warehouse.
        type: string
        example: SZX002
        readOnly: true
      id:
        description: The unique warehouse ID
        type: string
        example: WH0SZ001
      language:
        description: The local language for the warehouse.
        type: string
        example: Chinese
        readOnly: true
      language_code:
        description: The local language code for the warehouse in ISO 639-1 format.
        type: string
        example: zh
        readOnly: true
      name:
        description: The warehouse name.
        type: string
        example: BoxC Shenzhen 1
        readOnly: true
    required:
    - id
  NotFound:
    $ref: '#/definitions/not-found'
  WarehouseStorage:
    $ref: '#/definitions/warehouse-storage'
  unauthorized:
    description: Unauthorized
    content:
      application/json:
        schema:
          type: object
          summary: Unauthorized
          description: Lack of valid authentication credentials for the resource
          properties:
            code:
              description: Error code. Refer to the list of [Errors](/#tag/Errors).
              type: integer
            message:
              description: Error message explaining the code.
              type: string
            status:
              type: string
              enum:
              - error
              example: error
            errors:
              description: Displays processing error.
              type: array
              minItems: 1
              maxItems: 1
              items:
                type: string
        examples:
          accessToken:
            summary: Invalid access token
            description: Invalid access token
            value:
              code: 1005
              message: Invalid access token
              errors:
              - Invalid access token
  not-found:
    type: object
    summary: Not Found
    description: Object not found or not owned by the user
    properties:
      code:
        description: Error code. Refer to the list of [Errors](/#tag/Errors).
        type: integer
      message:
        description: Error message explaining the code.
        type: string
      status:
        type: string
        enum:
        - error
        example: error
      errors:
        description: Duplicate of the error message
        type: array
        items:
          type: string
  rate-limit:
    description: Too Many Requests
    content:
      application/json:
        schema:
          type: object
          summary: Too Many Requests
          description: Error for too many requests in a given time frame. See [Rate Limits](/#tag/RateLimit) for more information.
          properties:
            code:
              description: Error code. Refer to the list of [Errors](/#tag/Errors).
              type: integer
            message:
              description: Error message explaining the code.
              type: string
            status:
              type: string
              enum:
              - error
              example: error
            errors:
              description: Displays processing error.
              type: array
              minItems: 1
              maxItems: 1
              items:
                type: string
        examples:
          rateLimit:
            summary: Too Many Requests
            description: Too many requests. Please wait before trying again.
            value:
              code: 1015
              message: Too many requests. Please wait before trying again.
              errors:
              - Too many requests. Please wait before trying again.
  Forbidden:
    $ref: '#/definitions/forbidden'
  Unauthorized:
    $ref: '#/definitions/unauthorized'
  Warehouse:
    $ref: '#/definitions/warehouse'
  RateLimit:
    $ref: '#/definitions/rate-limit'
  forbidden:
    description: Forbidden
    content:
      application/json:
        schema:
          type: object
          summary: Forbidden
          description: Error relating to insufficient permissions for a resource
          properties:
            code:
              description: Error code. Refer to the list of [Errors](/#tag/Errors).
              type: integer
            message:
              description: Error message explaining the code.
              type: string
            status:
              type: string
              enum:
              - error
              example: error
            errors:
              description: Displays processing error.
              type: array
              minItems: 1
              maxItems: 1
              items:
                type: string
        examples:
          revoked:
            summary: Forbidden Authorization Revoked
            description: 'Forbidden: Authorization revoked'
            value:
              code: 1008
              message: 'Forbidden: Authorization revoked'
              errors:
              - 'Forbidden: Authorization revoked'
          scope:
            summary: Forbidden Scope
            description: 'Forbidden: Missing required scope'
            value:
              code: 1009
              message: 'Forbidden: Missing required scope'
              errors:
              - 'Forbidden: Missing required scope'
securityDefinitions:
  JWT:
    type: http
    scheme: bearer
    bearerScheme: JWT
    in: header
    description: All operations require a JSON Web Token after completing an [OAuth2 flow](#tag/Authentication).
  PrivilegedClient:
    type: http
    scheme: bearer
    bearerScheme: JWT
    description: Some clients require special privileges to use operations. No additional scope is needed.
x-servers:
- url: https://api.boxc.com/v1
x-tagGroups:
- name: Overview
  tags:
  - Introduction
  - Authentication
  - RateLimit
  - Paginate
  - Changelog
- name: Operations
  tags:
  - CalculateDuty
  - Classify
  - Invoices
  - Users
  - ValidateAddress
  - Webhooks
- name: Shipping
  tags:
  - Credentials
  - CustomsProducts
  - EntryPoints
  - Estimate
  - Labels
  - Manifests
  - Overpacks
  - Shipments
  - Track
- name: Fulfillment
  tags:
  - Inbound
  - Orders
  - Products
  - Shops
  - Warehouses
- name: Returns
  tags:
  - Reshipments
  - Returns
- name: Data
  tags:
  - CarrierCredentials
  - DangerousGoods
  - Errors
  - Languages
  - CarrierParameters
  - ReturnsProcess
  - TrackingEvents