swagger: '2.0'
info:
  x-logo:
    url: https://storage.googleapis.com/boxc_cdn/public/boxc-logo.png
    altText: BoxC
  title: BoxC CalculateDuty EntryPoints 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: EntryPoints
  x-displayName: Entry Points
  description: 'An entry point is the drop off location / origin for your shipments which affects your rates and the routes available. The `entry_point.id` is required when creating a shipment. You must query this endpoint to get an active list of entry points as some of added, changed, or removed.

    '
paths:
  /entry-points:
    get:
      tags:
      - EntryPoints
      summary: GET /entry-points
      description: Retrieves a list of entry points.
      operationId: getEntryPoints
      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/entry-points\n"
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  entry_points:
                    type: array
                    items:
                      $ref: '#/definitions/EntryPoint'
        '401':
          $ref: '#/definitions/Unauthorized'
        '403':
          $ref: '#/definitions/Forbidden'
        '429':
          $ref: '#/definitions/RateLimit'
  /entry-points/{id}:
    get:
      tags:
      - EntryPoints
      summary: GET /entry-points/{id}
      description: Retrieves an entry point.
      operationId: getEntryPointsById
      consumes:
      - application/json
      produces:
      - application/json
      security:
      - JWT: []
      parameters:
      - name: id
        in: path
        description: The entry point ID
        required: true
        type: string
        minLength: 6
        maxLength: 6
      x-codeSamples:
      - lang: cURL
        label: cURL
        source: "curl -H \"Authorization: Bearer <YOUR TOKEN>\" \\\n  -H \"Accept: application/json\" \\\n  https://api.boxc.com/v1/entry-points/{id}\n"
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  entry_point:
                    $ref: '#/definitions/EntryPoint'
        '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: Entry point not found
                  value:
                    code: 1040
                    message: Entry point not found
                    errors:
                    - Entry point not found
        '429':
          $ref: '#/definitions/RateLimit'
definitions:
  entry-point:
    type: object
    properties:
      address:
        description: The entry point's address with new lines.
        deprecated: true
        type: string
        example: 'WOC c/o Global Alliance Logistics (HK) Ltd

          Room 108, 1/F, Air Freight Forwarding Centre

          No. 2 Chun Wan Road, Chap Lap Kok, Lantau Isl., Hong Kong'
        readOnly: true
      city:
        description: The entry point's city.
        type: string
        maxLength: 40
        example: Hong Kong
        readOnly: true
      country:
        description: The entry point's country in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
        type: string
        pattern:
        - A-Z
        minLength: 2
        maxLength: 2
        example: HK
        readOnly: true
      delivery_address:
        description: The entry point's delivery address formatted and localized according to that country's standards.
        type: string
        example: 'WOC c/o Global Alliance Logistics (HK) Ltd

          Room 108, 1/F, Air Freight Forwarding Centre

          No. 2 Chun Wan Road, Chap Lap Kok, Lantau Isl., Hong Kong'
        readOnly: true
      id:
        description: The ID of the entry point.
        type: string
        minLength: 6
        maxLength: 6
        example: HKG101
        readOnly: true
      name:
        description: The addressee of the entry point.
        type: string
        maxLength: 40
        example: BoxC C/O SDL
        readOnly: true
      notes:
        type: string
        description: Additional contact and delivery information.
        example: 聯繫人：ELAINE NG 聯繫方式：3899 2931
        readOnly: true
      province:
        description: The entry point's province code.
        type: string
        maxLength: 40
        default: null
        example: null
        readOnly: true
      postal_code:
        description: The entry point's postal code.
        type: string
        default: null
        example: null
        maxLength: 10
        readOnly: true
      street1:
        description: The entry point's second street address if needed.
        maxLength: 50
        type: string
        example: 元朗錦田新潭路逢吉鄉300 号DD107
        readOnly: true
      street2:
        description: The entry point's second street address if needed.
        maxLength: 50
        type: string
        default: null
        example: null
        readOnly: true
  NotFound:
    $ref: '#/definitions/not-found'
  EntryPoint:
    $ref: '#/definitions/entry-point'
  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.
  Unauthorized:
    $ref: '#/definitions/unauthorized'
  Forbidden:
    $ref: '#/definitions/forbidden'
  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