openapi: 3.2.0
info:
  contact:
    email: hello@arta.io
    name: Arta
    url: https://manual.arta.io/
  description: The Arta Public API provides quote generation, transport booking, and tracking capabilities. Additionally the API enables Arta partner organizations to configure email and webhook notifications for their accounts.
  termsOfService: https://www.arta.io/legal/terms
  title: Arta Public Webhook Deliveries API
  version: '2021-01-01'
servers:
- url: https://api.arta.io
  variables: {}
security: []
tags:
- name: webhook_deliveries
paths:
  /webhook_deliveries:
    get:
      callbacks: {}
      deprecated: false
      description: Retrieve a paginated collection of Webhook Deliveries belonging to your Organization
      operationId: webhookDeliveries/list
      parameters:
      - description: Authorize your API calls with an Arta API token
        example: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y
        in: header
        name: Authorization
        required: true
        schema:
          type: string
          x-struct: null
          x-validate: null
      - description: Page number of the results to fetch.
        in: query
        name: page
        schema:
          default: 1
          type: integer
          x-struct: null
          x-validate: null
      - description: Results per page (max 50)
        in: query
        name: page_size
        schema:
          default: 20
          type: integer
          x-struct: null
          x-validate: null
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  items:
                    items:
                      $ref: '#/components/schemas/WebhookDeliveryListItem'
                    type: array
                    x-struct: null
                    x-validate: null
                  metadata:
                    properties:
                      page:
                        example: 1
                        format: int64
                        readOnly: true
                        type: integer
                        x-struct: null
                        x-validate: null
                      page_size:
                        example: 20
                        format: int64
                        readOnly: true
                        type: integer
                        x-struct: null
                        x-validate: null
                      total_count:
                        example: 1
                        format: int64
                        readOnly: true
                        type: integer
                        x-struct: null
                        x-validate: null
                    type: object
                    x-struct: null
                    x-validate: null
                type: object
                x-struct: null
                x-validate: null
          description: A collection of Webhook Deliveries
          headers:
            content-type:
              example: application/json
              schema:
                type: string
                x-struct: null
                x-validate: null
              style: simple
            x-arta-request-id:
              description: A unique identifier for the Arta API call
              example: FkBjuxbwLLTx4RoAARkx
              schema:
                type: string
                x-struct: null
                x-validate: null
              style: simple
      summary: List Webhook Deliveries
      tags:
      - webhook_deliveries
  /webhook_deliveries/{webhook_delivery_id}:
    get:
      callbacks: {}
      deprecated: false
      description: Retrieve an existing Webhook Delivery
      operationId: webhookDeliveries-get
      parameters:
      - description: Authorize your API calls with an Arta API token
        example: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y
        in: header
        name: Authorization
        required: true
        schema:
          type: string
          x-struct: null
          x-validate: null
      - description: webhook_delivery_id parameter
        in: path
        name: webhook_delivery_id
        required: true
        schema:
          type: string
          x-struct: null
          x-validate: null
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookDelivery'
          description: Successful Webhook Delivery response
          headers:
            content-type:
              example: application/json
              schema:
                type: string
                x-struct: null
                x-validate: null
              style: simple
            x-arta-request-id:
              description: A unique identifier for the Arta API call
              example: FkBjuxbwLLTx4RoAARkx
              schema:
                type: string
                x-struct: null
                x-validate: null
              style: simple
        '404':
          content:
            application/json:
              schema:
                properties:
                  errors:
                    properties:
                      detail:
                        example: string
                        type: string
                        x-struct: null
                        x-validate: null
                    type: object
                    x-struct: null
                    x-validate: null
                title: NotFound
                type: object
                x-struct: null
                x-validate: null
          description: Not Found
          headers:
            content-type:
              example: application/json
              schema:
                type: string
                x-struct: null
                x-validate: null
              style: simple
            x-arta-request-id:
              description: A unique identifier for the Arta API call
              example: FkBjuxbwLLTx4RoAARkx
              schema:
                type: string
                x-struct: null
                x-validate: null
              style: simple
      summary: Get a Webhook Delivery
      tags:
      - webhook_deliveries
components:
  schemas:
    WebhookDelivery:
      properties:
        created_at:
          example: '2021-10-27T16:48:38.657228'
          readOnly: true
          type: string
          x-struct: null
          x-validate: null
        id:
          description: The string ID for this webhook delivery resource
          example: 5b6e1621-454f-4f18-aecf-87192406effe
          readOnly: true
          type: string
          x-struct: null
          x-validate: null
        next_retry:
          description: The UTC timestamp describing when a follow up webhook delivery event will be attempted if this one has failed
          nullable: true
          readOnly: true
          type: string
          x-struct: null
          x-validate: null
        request_body:
          description: A stringified JSON representation of the data Arta sent to your endpoint
          example: '{"data":{"id":432672},"object":"webhook","type":"ping"}'
          readOnly: true
          type: string
          x-struct: null
          x-validate: null
        resource_id:
          description: The ID of the resource that triggered the webhook event
          example: 9c67b26c-6b5d-4e19-a703-f7356f82d7e0
          readOnly: true
          type: string
          x-struct: null
          x-validate: null
        resource_type:
          description: The type of resource that triggered the webhook event
          enum:
          - ping
          - request
          - shipment
          example: request
          readOnly: true
          type: string
          x-struct: null
          x-validate: null
        response_body:
          description: A string representation of the response body Arta received from your endpoint
          example: '{"received": true}'
          readOnly: true
          type: string
          x-struct: null
          x-validate: null
        response_status_code:
          description: The numerical HTTP status code Arta received from your endpoint
          example: 202
          readOnly: true
          type: number
          x-struct: null
          x-validate: null
        status:
          description: The status of the webhook delivery event
          enum:
          - delivered
          - failed
          example: delivered
          readOnly: true
          type: string
          x-struct: null
          x-validate: null
        type:
          description: The type of webhook delivery sent to your endpoint
          enum:
          - ping
          - request.created
          - request.shared
          - request.status.updated
          - request.updated
          - shipment.created
          - shipment.eei_form_status.updated
          - shipment.exceptions.updated
          - shipment.schedule.updated
          - shipment.status.updated
          - shipment.tracking.updated
          - shipment.updated
          - shipment_exception.created
          - shipment_exception.status.updated
          example: ping
          readOnly: true
          type: string
          x-struct: null
          x-validate: null
        webhook_id:
          description: The ID belonging to your webhook endpoint in Arta's system
          example: 432672
          readOnly: true
          type: integer
          x-struct: null
          x-validate: null
        webhook_url:
          description: The URL belonging to your webhook endpoint in Arta's system at the time Arta attempted delivery of the webhook event
          example: https://hooks.mydomain.xyz/arta
          readOnly: true
          type: string
          x-struct: null
          x-validate: null
      title: WebhookDelivery
      type: object
      x-struct: Elixir.DocsWeb.Schemas.Response.WebhookDelivery
      x-validate: null
    WebhookDeliveryListItem:
      properties:
        created_at:
          example: '2021-10-27T16:48:38.657228'
          readOnly: true
          type: string
          x-struct: null
          x-validate: null
        id:
          description: The string ID for this webhook delivery resource
          example: 5b6e1621-454f-4f18-aecf-87192406effe
          readOnly: true
          type: string
          x-struct: null
          x-validate: null
        next_retry:
          description: The UTC timestamp describing when a follow up webhook delivery event will be attempted if this one has failed
          nullable: true
          readOnly: true
          type: string
          x-struct: null
          x-validate: null
        resource_id:
          description: The ID of the resource that triggered the webhook event
          example: 9c67b26c-6b5d-4e19-a703-f7356f82d7e0
          readOnly: true
          type: string
          x-struct: null
          x-validate: null
        resource_type:
          description: The type of resource that triggered the webhook event
          enum:
          - ping
          - request
          - shipment
          example: request
          readOnly: true
          type: string
          x-struct: null
          x-validate: null
        response_status_code:
          example: 202
          readOnly: true
          type: number
          x-struct: null
          x-validate: null
        status:
          description: The status of the webhook delivery event
          enum:
          - delivered
          - failed
          example: delivered
          readOnly: true
          type: string
          x-struct: null
          x-validate: null
        type:
          description: The type of webhook delivery sent to your endpoint
          enum:
          - ping
          - request.created
          - request.shared
          - request.status.updated
          - request.updated
          - shipment.created
          - shipment.eei_form_status.updated
          - shipment.exceptions.updated
          - shipment.schedule.updated
          - shipment.status.updated
          - shipment.tracking.updated
          - shipment.updated
          - shipment_exception.created
          - shipment_exception.status.updated
          example: ping
          readOnly: true
          type: string
          x-struct: null
          x-validate: null
        webhook_id:
          description: The ID belonging to your webhook endpoint in Arta's system
          example: 432672
          readOnly: true
          type: integer
          x-struct: null
          x-validate: null
        webhook_url:
          description: The URL belonging to your webhook endpoint in Arta's system at the time Arta attempted delivery of the webhook event
          example: https://hooks.mydomain.xyz/arta
          readOnly: true
          type: string
          x-struct: null
          x-validate: null
      title: WebhookDeliveryListItem
      type: object
      x-struct: Elixir.DocsWeb.Schemas.Response.WebhookDeliveryListItem
      x-validate: null
x-topics:
- content: 'The Arta API accepts server-to-server communications authenticated by API keys. Your API keys are self-managed and unique to your organization.


    Using your API key to authenticate an API call is straightforward. Simply include your API Key token in the Authorization header of every call made to the system. This is the only place that it is accepted.'
  example: "```shell\n\n$ curl \\ \n\n -X GET https://api.arta.io/shipments \\ \n\n -H \"Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y\""
  title: Authentication
- content: "Arta imposes rate limits on API requests to maintain system stability and ensure fair usage. If you exceed these limits, the API will return a `429 Too Many Requests` error. Below are the rate limits for both Live and Test modes.\n\n**Live Mode:**\n\n*\tConcurrent requests: 15 API calls at the same time (any type)\n* Instant quote requests: 20 calls per minute\n* Overall requests: 1000 API calls per minute (any type)\n\n**Test Mode:**\n\n* Concurrent requests: 10 API calls at the same time (any type)\n* Instant quote requests: 10 calls per minute\n* Overall requests: 500 API calls per minute (any type)\n\nWhen a rate limit is exceeded, we recommend implementing retry logic with exponential backoff to handle 429 errors effectively."
  title: Rate Limits
- content: 'The Arta API supports flexible search functionality across multiple resources, including Shipments, Requests, Hosted Sessions, Tags, and others. Using the search query parameter, you can construct structured queries to filter results based on specific criteria.


    Key features of the search functionality include:


    * Support for negation, wildcards, numeric filters, and date comparisons.

    * Each search query consists of one or more clauses, where each clause contains a `field`, an operator, and a `value`.

    * Clauses operating on the same field are combined using OR logic, while clauses across different fields are combined using AND logic.


    * Use quotation marks to keep multi-word search terms together.


    This allows for powerful and precise filtering to retrieve the exact data you need from the API.


    **Syntax and operators**


    The following table lists the operators and syntax that you can use to construct a search query clause.


    | Operator     | Usage                          | Description                                                                 | Examples                                                            |

    |------------|--------------------------------|-----------------------------------------------------------------------------|---------------------------------------------------------------------|

    | `:`        | `field:value`                  | Exact match operator (case insensitive)                                     | `status:pending` returns records where the status is `pending` |

    | `*`        | `value*`                       | Use an asterisk (wildcard operator) at the end of a term to match fields that start with the fragment                                    | `art*` returns records that match "arta" and "artist" but not "smart" |

    | `*`        | `*value`                       | Use an asterisk at the start of a term to match fields that end with the fragment                                    | `*art` returns "smart" but not "martian" |

    | `-`        | `-field:value`                 | Returns records that don’t match the clause                                 | `-status:pending` returns records that do not have a status of pending                 |

    | `>, <, =`  | `field:<value`, `field:>value`, `field:>=value`, `field:<=value` | Greater than/less than operators              | `created-at:<=2021-01-01` returns records from the beginning of time through January 1, 2021   |

    | `..`       | `field:value1..value2`                 | Filters for values within a given range where the first number is the lowest value and the second is the highest                                 | `created-at:2021-05-01..2021-05-15` returns records where the `created_at` field is between May 1, 2021 and May 15, 2021                 |




    **Hosted Session search fields**


    | Field | Type |

    |------------|--------------|

    | `created-at` | date |

    | `destination-address-line-1` | string |

    | `destination-city` | string |

    | `destination-contacts-emails` | string |

    | `destination-contacts-names` | string |

    | `destination-contacts-phone-numbers` | string |

    | `destination-country` | string |

    | `destination-postal-code` | string |

    | `destination-region` | string |

    | `insurance` | string |

    | `internal-reference` | string |

    | `object-creators` | string |

    | `object-descriptions` | string |

    | `object-internal-references` | string |

    | `object-public-references` | string |

    | `object-titles` | string |

    | `origin-address-line-1` | string |

    | `origin-city` | string |

    | `origin-contacts-emails` | string |

    | `origin-contacts-names` | string |

    | `origin-contacts-phone-numbers` | string |

    | `origin-country` | string |

    | `origin-postal-code` | string |

    | `origin-region` | string |

    | `public-reference` | string |

    | `quote-type` | string |

    | `shipping-notes` | string |

    | `shortcode` | string |

    | `status` | string |

    | `type` | string |

    | `tags` | string |


    **Request search fields**


    | Field | Type |

    |------------|--------------|

    | `bookable` | string |

    | `created-at` | date |

    | `destination-address-line-1` | string |

    | `destination-city` | string |

    | `destination-contacts-emails` | string |

    | `destination-contacts-names` | string |

    | `destination-contacts-phone-numbers` | string |

    | `destination-country` | string |

    | `destination-postal-code` | string |

    | `destination-region` | string |

    | `hosted-session` | string |

    | `internal-reference` | string |

    | `object-creators` | string |

    | `object-descriptions` | string |

    | `object-internal-references` | string |

    | `object-public-references` | string |

    | `object-titles` | string |

    | `origin-address-line-1` | string |

    | `origin-city` | string |

    | `origin-contacts-emails` | string |

    | `origin-contacts-names` | string |

    | `origin-contacts-phone-numbers` | string |

    | `origin-country` | string |

    | `origin-postal-code` | string |

    | `origin-region` | string |

    | `public-reference` | string |

    | `quote-type` | string |

    | `shipping-notes` | string |

    | `shortcode` | string |

    | `status` | string |

    | `tags` | string |


    **Shipment search fields**


    | Field | Type |

    |------------|--------------|

    | `created-at` | date |

    | `destination-address-line-1` | string |

    | `destination-city` | string |

    | `destination-contacts-emails` | string |

    | `destination-contacts-names` | string |

    | `destination-contacts-phone-numbers` | string |

    | `destination-country` | string |

    | `destination-postal-code` | string |

    | `destination-region` | string |

    | `eei-form-status` | string |

    | `hosted-session` | string |

    | `internal-reference` | string |

    | `object-creators` | string |

    | `object-descriptions` | string |

    | `object-internal-references` | string |

    | `object-public-references` | string |

    | `object-titles` | string |

    | `origin-address-line-1` | string |

    | `origin-city` | string |

    | `origin-contacts-emails` | string |

    | `origin-contacts-names` | string |

    | `origin-contacts-phone-numbers` | string |

    | `origin-country` | string |

    | `origin-postal-code` | string |

    | `origin-region` | string |

    | `public-reference` | string |

    | `quote-type` | string |

    | `request-shortcode` | string |

    | `shipping-notes` | string |

    | `shortcode` | string |

    | `status` | string |

    | `tags` | string |

    | `total` | numeric |

    | `total-currency` | string |

    | `tracking-numbers` | string |


    **Tag search fields**


    | Field | Type |

    |------------|--------------|

    | `color` | string |

    | `description` | string |

    | `is_active` | string |

    | `name` | string |


    '
  title: Search