Do not miss any Arta API Reference changes, ever again

Subscribe to the Arta API Reference changelog to be up to date on recent changes.

RSS

Nov 8, 2024

release
2021-01-01
Compare

API structure has changed

40 structure changes including:
1 Breaking change
2 Additions
36 Modifications
2 Removals
Modified 36 Breaking
PATCH /email_rules/{email_rule_id}
  • Body
  • application/json content type Modified
    • email_rule property Modified
      • Property is now required
        Breaking
PATCH /email_subscriptions/{email_subscription_id}
  • Body
  • application/json content type Modified
    • email_subscription property Modified
      • Property is now required
        Breaking
      • recipients property Modified
        • Property is now required
          Breaking
PATCH /hosted_sessions/{hosted_session_id}/cancel
  • Response
  • 200 response Modified
    • application/json content type Modified
      • objects, tags properties Added
PATCH /organization
  • Body
  • application/json content type Modified
    • organization property Modified
      • Property is now required
        Breaking
PATCH /requests/{request_id}/cancel
  • Response
  • 200 response Modified
    • application/json content type Modified
      • quotes property Modified
        • tags property Added
PATCH /requests/{request_id}/contacts
  • Response
  • 200 response Modified
    • application/json content type Modified
      • quotes property Modified
        • tags property Added
PATCH /requests/{request_id}/custom
  • Response
  • 200 response Modified
    • application/json content type Modified
      • quotes property Modified
        • tags property Added
PATCH /shipment_exceptions/{shipment_exception_id}
  • Body
  • application/json content type Modified
    • shipment_exception property Modified
      • Property is now required
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • status property Modified
        • Type is now string
  • 404 response Added
PATCH /tags/{tag_name}
  • Response
  • 404 response Added
PATCH /webhooks/{webhook_id}
  • Body
  • application/json content type Modified
    • webhook property Modified
      • Property is now required
        Breaking
POST /api_keys
  • Body
  • application/json content type Modified
    • api_key property Modified
      • Property is now required
        Breaking
POST /email_rules
  • Body
  • application/json content type Modified
    • email_rule property Modified
      • Property is now required
        Breaking
POST /email_subscriptions
  • Body
  • application/json content type Modified
    • email_subscription property Modified
      • Property is now required
        Breaking
POST /hosted_sessions
  • Body
  • application/json content type Modified
    • Booking session, Share request alternatives Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • BookingSession, ShareRequest alternatives Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • objects, tags properties Added
POST /requests
  • Body
  • application/json content type Modified
    • request property Modified
      • tags property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • quotes property Modified
        • tags property Added
POST /shipment_exceptions
  • Body
  • application/json content type Modified
    • shipment_exception property Modified
      • Property is now required
        Breaking
      • type property Modified
        • Type is now string
POST /shipments
  • Body
  • application/json content type Modified
    • object-1, object-2 alternatives Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • ArtaShipmentPayload, TrackShipmentPayload alternatives Added
  • Response
  • 422 response Modified
    • application/json content type Modified
      • errors property Added
  • 200 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 201, 400, 403 responses Added
POST /tags
  • Body
  • application/json content type Modified
    • tag property Modified
      • Property is now required
        Breaking
      • is_active property Modified
        • Type went from boolean to boolean | null
  • Response
  • 403, 422 responses Added
POST /webhooks
  • Body
  • application/json content type Modified
    • webhook property Modified
      • Property is now required
        Breaking
  • Response
  • 400 response Modified
    • application/json content type Modified
      • Type is no longer object
        Breaking
      • property Removed
DELETE /api_keys/{api_key_id}
  • Response
  • 204 response Modified
    • application/json content type Added
DELETE /attachments/{attachment_id}
  • Response
  • 204 response Modified
    • application/json content type Added
DELETE /email_rules/{email_rule_id}
  • Response
  • 204 response Modified
    • application/json content type Added
DELETE /email_subscriptions/{email_subscription_id}
  • Response
  • 204 response Modified
    • application/json content type Added
DELETE /uploads/{upload_id}
  • Response
  • 204 response Modified
    • application/json content type Added
DELETE /webhooks/{webhook_id}
  • Response
  • 204 response Modified
    • application/json content type Added
GET /hosted_sessions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • objects, tags properties Added
GET /hosted_sessions/{hosted_session_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • objects, tags properties Added
GET /invoice_payments
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • amount_owed, amount_owed_currency, amount_paid, amount_paid_currency, invoice_url, issued_on, status properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • amount, amount_currency, invoice_id, payment_id properties Added
GET /payments
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • amount_owed, amount_owed_currency, amount_paid, amount_paid_currency, invoice_url, issued_on, shipment_id, status properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • amount, amount_currency, context, paid_on properties Added
GET /requests/{request_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • quotes property Modified
        • tags property Added
GET /shipment_exceptions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • status property Modified
          • Type is now string
      • metadata property Modified
        • is_estimate property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
GET /shipment_exceptions/{shipment_exception_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • status property Modified
        • Type is now string
GET /shipments
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • tags property Added
GET /shipments/{shipment_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • exceptions property Modified
        • hold_until, source properties Added
      • object_count, package_count properties Modified
        • Permission is no longer readOnly
        • Type went from number to integer(int64)
          Breaking
      • packages property Modified
        • objects property Modified
      • services property Modified
        • Permission is no longer readOnly
        • included_services property Modified
          • Permission is no longer readOnly
          • Type went from array to array[object]
      • tags property Added
GET /tags
  • Response
  • 200 response Modified
    • application/json content type Modified
      • metadata property Modified
        • is_estimate property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
GET /tags/{tag_name}
  • Response
  • 404 response Added
Removed 2 Breaking
GET /metadata/commercial_carriers
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /metadata/location_access_restrictions
Added 2
GET /metadata/location_access_restrictions
GET /metadata/commercial_carriers