Check Self-Ship Collection Availability

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://api-reference.arta.io/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json 
{
  "Arta API Reference MCP server": {
    "url": "https://api-reference.arta.io/mcp"
  }
}
Close
POST /self_ship_collection_availability_checks

Availability: Public Preview

This endpoint is currently in public preview and available only to approved accounts. Please contact Arta to request access for your organization.

Check carrier pickup availability for a given location, service, and date.

For fedex, availability comes directly from FedEx for each request, so the response is the source of truth for bookable dates and times. It covers the requested date and can include availability for up to two later dates.

For dhl, collections can be scheduled up to 10 days in advance, Monday through Friday, with hourly collection times from 09:00 to 15:00. Collection times that have already passed at the pickup location, or that leave less than 3 hours before location.close_time, are not returned.

Headers

  • Authorization string Required

    Authorize your API calls with an Arta API token

application/json

Body

  • self_ship_collection_availability_check object Required
    Hide self_ship_collection_availability_check attributes Show self_ship_collection_availability_check attributes object
    • collection_date string(date) Required

      Date to check availability for in ISO 8601 format (YYYY-MM-DD)

    • location object Required

      Pickup location to check availability for

      Hide location attributes Show location attributes object
      • address_line_1 string Required

        Street address

        Minimum length is 1.

      • address_line_2 string | null

        Additional address info

      • city string Required

        City

        Minimum length is 1.

      • close_time string Required

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

      • country string Required

        Two-letter country code. Currently US and GB are supported.

        Minimum length is 2, maximum length is 2.

      • postal_code string Required

        Postal code

        Minimum length is 1.

      • region string

        State or territory code. Required for US addresses and must be a valid US state or territory code; may be omitted for GB addresses.

    • service object Required

      Carrier service to check availability for

      Hide service attributes Show service attributes object
      • carrier string Required

        Carrier identifier. fedex and dhl are supported.

        Values are fedex or dhl.

      • code string Required

        Service level code

        Values are ground or express.

      • route string Required

        Route type.

        Values are domestic or international.

Responses

  • 200 application/json

    Available pickup slots for the given parameters

    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
    • availabilities array[object]

      Available pickup slots. May be empty if no slots are available.

      Hide availabilities attributes Show availabilities attributes object
      • collection_date string(date)

        Available pickup date (YYYY-MM-DD)

      • collection_times array[string]

        Available pickup times in ISO 8601 format (HH:MM:SS)

      • residential_available boolean

        Whether residential pickup is available

    • collection_date string(date)

      The date that was checked for availability (YYYY-MM-DD)

    • location object

      The pickup location that was checked

      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)

      • country string

        Two-letter country code

      • postal_code string

        Postal code

      • region string

        State or province code

    • service object

      The carrier service that was checked

      Hide service attributes Show service attributes object
      • carrier string

        Carrier identifier

        Values are fedex or dhl.

      • code string

        Service level code

        Values are ground or express.

      • route string

        Route type

        Values are domestic or international.
  • 400 application/json

    Availability could not be checked, for example because the pickup location is outside the supported countries

    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 array[string] Required

      Human-readable error messages that apply to the request as a whole
  • 403 application/json

    Forbidden

  • 422 application/json

    The request body failed validation

    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
POST /self_ship_collection_availability_checks 
curl \
 --request POST 'https://api.arta.io/self_ship_collection_availability_checks' \
 --header "Content-Type: application/json" \
 --header "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y" \
 --data '{
  "self_ship_collection_availability_check": {
    "collection_date": "2026-03-06",
    "location": {
      "address_line_1": "123 Main St",
      "address_line_2": "string",
      "city": "New York",
      "close_time": "17:00:00",
      "country": "US",
      "postal_code": "10001",
      "region": "NY"
    },
    "service": {
      "carrier": "fedex",
      "code": "ground",
      "route": "domestic"
    }
  }
}'
Request examples 
# Headers
Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y

# Payload
{
  "self_ship_collection_availability_check": {
    "collection_date": "2026-03-06",
    "location": {
      "address_line_1": "123 Main St",
      "address_line_2": "string",
      "city": "New York",
      "close_time": "17:00:00",
      "country": "US",
      "postal_code": "10001",
      "region": "NY"
    },
    "service": {
      "carrier": "fedex",
      "code": "ground",
      "route": "domestic"
    }
  }
}
Response examples (200) 
# Headers
content-type: application/json
x-arta-request-id: FkBjuxbwLLTx4RoAARkx

# Payload
{
  "availabilities": [
    {
      "collection_date": "2026-03-06",
      "collection_times": [
        "07:00:00",
        "07:30:00",
        "08:00:00"
      ],
      "residential_available": true
    }
  ],
  "collection_date": "2026-03-06",
  "location": {
    "address_line_1": "123 Main St",
    "city": "New York",
    "close_time": "17:00:00",
    "country": "US",
    "postal_code": "10001",
    "region": "NY"
  },
  "service": {
    "carrier": "fedex",
    "code": "ground",
    "route": "domestic"
  }
}
Response examples (400) 
{
  "errors": [
    "Only UK and US are supported for DHL self-ship collections"
  ]
}
Response examples (422) 
{
  "errors": {
    "service": [
      "Required property route was not present."
    ]
  }
}