Get an Attachment

GET /attachments/{attachment_id}

Retrieve an existing Attachment

Headers

  • Authorization string Required

    Authorize your API calls with an Arta API token

Path parameters

Responses

  • 200 application/json

    Successful Attachment response

    Hide headers attributes Show headers attributes
    Hide response attributes Show response attributes object
    • request_id string | null

      The string ID of the request resource associated to an upload via this attachment. Null if this attachment associate a shipment

    • shipment_id string | null

      The string ID of the shipment resource associated to an upload via this attachment. Null if this attachment associate a request

    • id integer
    • upload_id integer Required

      The integer ID of the Upload resource associated with either a shipment or request via this attachment

  • 404 application/json

    Resource Not Found

    Hide headers attributes Show headers attributes
    Hide response attribute Show response attribute object

    Basic Error

GET /attachments/{attachment_id}
curl \
 -X GET https://api.arta.io/attachments/{attachment_id} \
 -H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"
Response examples (200)
# Headers
content-type: application/json
x-arta-request-id: FkBjuxbwLLTx4RoAARkx

# Payload
{
  "created_at": "2021-10-27T16:48:38.657228",
  "request_id": "506d79b6-1e5e-4e8c-a266-74658fdaf4ee",
  "shipment_id": "string",
  "id": 1942,
  "upload_id": 4791,
  "updated_at": "2021-10-27T16:48:38.657228"
}
Response examples (404)
# Headers
content-type: application/json
x-arta-request-id: FkBjuxbwLLTx4RoAARkx

# Payload
{
  "errors": {
    "detail": "string"
  }
}