Headers

• Authorization string Required

  Authorize your API calls with an Arta API token

Query parameters

• page integer

  Page number of the results to fetch.

  Default value is 1.

• page_size integer

  Results per page (max 50)

  Default value is 20.

• sort string

  An optional sort order for the returned collection.

  Values are created_at_asc, created_at_desc, updated_at_asc, or updated_at_desc.

Responses

• 200 application/json

  A collection of Self-Ship Collection records

  Hide headers attributes Show headers attributes

  • content-type string
  • x-arta-request-id string

    A unique identifier for the Arta API call

  Hide response attributes Show response attributes object

  • items array[object]
    Hide items attributes Show items attributes object

    • closed_at string | null

      A NaiveDatetime-formatted timestamp describing when the collection was closed

    • collection_date string(date)

      The pickup date in ISO 8601 format (YYYY-MM-DD).

    • collection_time string

      The pickup time in ISO 8601 format (HH:MM:SS).

    • created_at string

      A NaiveDatetime-formatted timestamp describing when the resource was created with microsecond precision

    • id string(uuid)

      The ID of the self-ship collection in UUID format

    • location object

      The pickup location details

      Hide location attributes Show location attributes object

      • address_line_1 string

        Street address

      • address_line_2 string | null

        Additional address info

      • city string

        City

      • close_time string

        Location closing time in ISO 8601 format (HH:MM:SS)

      • contact object

        Contact at the pickup location

        Hide contact attributes Show contact attributes object

        • email_address string

          Contact email address

        • name string

          Contact name

        • phone_number string

          Contact phone number

      • country string

        Two-letter country code

      • package_location string

        Where packages are located at the pickup location: the front, rear, or side of the building, or none when not specified. Always none for DHL collections.

        Values are front, none, rear, or side.

      • postal_code string

        Postal code

      • region string

        State or province code

    • service object

      Carrier service details

      Hide service attributes Show service attributes object

      • carrier string

        Carrier identifier

        Values are fedex or dhl.

      • code string

        Service level code

        Values are express or ground.

      • declared_value string | null

        Declared value of the collected packages, as a decimal string. null when no declared value was provided.

      • declared_value_currency string

        ISO 4217 three-letter code for declared_value. An empty string when no declared value was provided.

      • package_details object | null

        The packages the collection was booked with, echoed back in the shape they were submitted. null for FedEx collections.

        Hide package_details attribute Show package_details attribute object | null

        • packages array[object]

          The packages included in the collection, one entry per package. Dimensions and weight are decimal strings, and every package shares the same unit_of_measurement and weight_unit.

          Hide packages attributes Show packages attributes object

          • depth string

            Package depth

          • height string

            Package height

          • unit_of_measurement string

            Unit for depth, height, and width

            Values are in or cm.

          • weight string

            Package weight

          • weight_unit string

            Unit for weight

            Values are lb or kg.

          • width string

            Package width

      • route string

        Route type

        Values are domestic or international.

    • shortcode string

      A human-readable identifier for the collection, formatted as the organization's shortcode followed by a hyphen and six alphanumeric characters

      Format should match the following pattern: ^[A-Z]+-[A-Z0-9]{6}$.

    • status string

      The current status of the collection

      Values are scheduled, closed, cancelled, or incomplete.

    • updated_at string

      A NaiveDatetime-formatted timestamp describing when the resource was last updated with microsecond precision

  • metadata object
    Hide metadata attributes Show metadata attributes object

    • page integer(int64)
    • page_size integer(int64)
    • total_count integer(int64)