Headers

• Authorization string Required

  Authorize your API calls with an Arta API token

Path parameters

• self_ship_collection_id string Required

  self_ship_collection_id parameter

Responses

• 200 application/json

  The cancelled self-ship collection

  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

  • 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

• 400 application/json

  The carrier rejected the cancellation. The carrier's messages are returned under #.

  Hide headers attributes Show headers attributes

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

    A unique identifier for the Arta API call

  Hide response attribute Show response attribute object

  • errors object Required

    Human-readable error messages keyed by the path of the offending field, for example location/region or service/carrier. Messages that apply to the request as a whole are keyed by #.

    Hide errors attribute Show errors attribute object

    • * array[string] Additional properties
• 403 application/json

  Forbidden

• 404 application/json

  Not Found

  Hide headers attributes Show headers attributes

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

    A unique identifier for the Arta API call

  Hide response attribute Show response attribute object

  • errors object
    Hide errors attribute Show errors attribute object

    • detail string
• 422 application/json

  The collection cannot be cancelled through the API. Only DHL collections can be cancelled.

  Hide headers attributes Show headers attributes

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

    A unique identifier for the Arta API call

  Hide response attribute Show response attribute object

  • errors object Required

    Human-readable error messages keyed by the path of the offending field, for example location/region or service/carrier. Messages that apply to the request as a whole are keyed by #.

    Hide errors attribute Show errors attribute object

    • * array[string] Additional properties