Change Updates

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

Changelog

Last update:
Compare
4 structure changes including:
4 Additions
Added 4
GET /tags
GET /tags/{tag_name}
PATCH /tags/{tag_name}
POST /tags
1 structure change including:
1 Modification
Modified 1 Breaking
POST /shipments
  • Body
  • application/json content type Modified
    • object-2 alternative Modified
      • tracking, internal_reference, public_reference, shipping_notes, origin, destination, packages properties Removed

        • Removing a resource is always breaking unless it was deprecated before

          Breaking

      • shipment property Added
  • Response
  • 422 response Added
2 structure changes including:
1 Addition
1 Modification
Modified 1
POST /shipments
  • Body
  • application/json content type Modified
    • object-1 alternative Modified
      • shipment property Modified
    • object-2 alternative Added
Added 1
GET /metadata/commercial_carriers
2 structure changes including:
2 Modifications
Modified 2
GET /shipments/{shipment_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • eei_form_url property Added
POST /shipments
  • Response
  • 200 response Modified
    • application/json content type Modified
      • eei_form_url property Added
5 structure changes including:
5 Modifications
Modified 5
GET /requests/{request_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • objects property Modified
PATCH /requests/{request_id}/cancel
  • Response
  • 200 response Modified
    • application/json content type Modified
      • objects property Modified
PATCH /requests/{request_id}/contacts
  • Response
  • 200 response Modified
    • application/json content type Modified
      • objects property Modified
PATCH /requests/{request_id}/custom
  • Response
  • 200 response Modified
    • application/json content type Modified
      • objects property Modified
POST /requests
  • Response
  • 201 response Modified
    • application/json content type Modified
      • objects property Modified
2 structure changes including:
2 Modifications
Modified 2
GET /shipments/{shipment_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • packages property Modified
POST /shipments
  • Response
  • 200 response Modified
    • application/json content type Modified
      • packages property Modified
5 structure changes including:
5 Additions
Added 5
GET /metadata/shipment_exception_types
GET /shipment_exceptions
GET /shipment_exceptions/{shipment_exception_id}
PATCH /shipment_exceptions/{shipment_exception_id}
POST /shipment_exceptions
1 structure change including:
1 Modification
Modified 1
POST /hosted_sessions
  • Body
  • content type Modified
    • object-1 alternative Modified
      • hosted_session property Modified
    • object-2 alternative Added
4 structure changes including:
4 Modifications
Modified 4 Breaking
GET /organization
  • Response
  • 200 response Modified
    • billing_terms, company_name, display_name, shortcode, status properties Added
GET /shipments/{shipment_id}
  • Response
  • 200 response Modified
    • emissions, emissions_unit, exceptions properties Added
PATCH /organization
  • Body
  • content type Modified
    • webhook property Removed
    • organization property Added
  • Response
  • 200 response Modified
    • billing_terms, company_name, display_name, shortcode, status properties Added
POST /shipments
  • Response
  • 200 response Modified
    • emissions, emissions_unit, exceptions properties Added
8 structure changes including:
1 Addition
7 Modifications
Modified 7
GET /metadata/object_materials
GET /requests/{request_id}
  • Response
  • 200 response Modified
    • objects property Modified
PATCH /requests/{request_id}/cancel
  • Response
  • 200 response Modified
    • objects property Modified
PATCH /requests/{request_id}/contacts
  • Response
  • 200 response Modified
    • objects property Modified
PATCH /requests/{request_id}/custom
  • Response
  • 200 response Modified
    • objects property Modified
POST /hosted_sessions
  • Body
  • content type Modified
    • hosted_session property Modified
POST /requests
  • Body
  • content type Modified
    • request property Modified
  • Response
  • 201 response Modified
    • objects property Modified
Added 1
PATCH /webhooks/{webhook_id}
7 structure changes including:
1 Breaking change
7 Modifications
Modified 7 Breaking
GET /metadata/location_access_restrictions
GET /requests/{request_id}
  • Response
  • 200 response Modified
    • payment_process property Modified
PATCH /requests/{request_id}/cancel
  • Response
  • 200 response Modified
    • payment_process property Modified
PATCH /requests/{request_id}/contacts
  • Response
  • 200 response Modified
    • payment_process property Modified
PATCH /requests/{request_id}/custom
  • Response
  • 200 response Modified
    • payment_process property Modified
PATCH /webhooks/{webhook_id}
  • Body
  • content type Added
POST /requests
  • Response
  • 201 response Modified
    • payment_process property Modified
15 structure changes including:
1 Breaking change
1 Addition
14 Modifications
Modified 14 Breaking
GET /hosted_sessions
  • Response
  • 200 response Modified
    • items property Modified
GET /hosted_sessions/{hosted_session_id}
  • Response
  • 200 response Modified
    • origin property Modified
    • payment_process property Added
GET /requests
  • Response
  • 200 response Modified
    • items property Modified
GET /requests/{request_id}
  • Response
  • 200 response Modified
    • destination, origin properties Modified
    • created_at, payment_process, updated_at properties Added
GET /shipments
  • Response
  • 200 response Modified
    • items property Modified
GET /shipments/{shipment_id}
  • Response
  • 200 response Modified
    • destination, origin properties Modified
    • created_at, package_count, payment_process, updated_at properties Added
PATCH /hosted_sessions/{hosted_session_id}/cancel
  • Response
  • 200 response Modified
    • origin property Modified
    • payment_process property Added
PATCH /requests/{request_id}/cancel
  • Response
  • 200 response Modified
    • destination, origin properties Modified
    • created_at, payment_process, updated_at properties Added
PATCH /requests/{request_id}/contacts
  • Response
  • 200 response Modified
    • destination, origin properties Modified
    • created_at, payment_process, updated_at properties Added
PATCH /requests/{request_id}/custom
  • Response
  • 200 response Modified
    • destination, origin properties Modified
    • created_at, payment_process, updated_at properties Added
PATCH /webhooks/{webhook_id}
  • Body
  • content type Added
POST /hosted_sessions
  • Response
  • 201 response Modified
    • origin property Modified
    • payment_process property Added
POST /requests
  • Response
  • 201 response Modified
    • destination, origin properties Modified
    • created_at, payment_process, updated_at properties Added
POST /shipments
  • Response
  • 200 response Modified
    • destination, origin properties Modified
    • created_at, package_count, payment_process, updated_at properties Added
Added 1
GET /metadata/payment_process_types
3 structure changes including:
1 Breaking change
3 Modifications
Modified 3 Breaking
GET /shipments/{shipment_id}
  • Response
  • 200 response Modified
    • tracking property Modified
PATCH /webhooks/{webhook_id}
  • Body
  • content type Added
POST /shipments
  • Response
  • 200 response Modified
    • tracking property Modified
4 structure changes including:
1 Breaking change
1 Addition
3 Modifications
Modified 3 Breaking
GET /shipments/{shipment_id}
  • Response
  • 200 response Modified
    • packages property Modified
PATCH /webhooks/{webhook_id}
  • Body
  • content type Added
POST /shipments
  • Response
  • 200 response Modified
    • packages property Modified
Added 1
GET /metadata/package_statuses
3 structure changes including:
2 Breaking changes
1 Addition
1 Modification
1 Removal
Modified 1 Breaking
PATCH /webhooks/{webhook_id}
  • Body
  • content type Added
Removed 1 Breaking
GET /webhook_delieveries/{webhook_delivery_id}
Added 1
GET /webhook_deliveries/{webhook_delivery_id}
11 structure changes including:
1 Breaking change
10 Additions
1 Modification
Modified 1 Breaking
PATCH /webhooks/{webhook_id}
  • Body
  • content type Added
Added 10
DELETE /attachments/{attachment_id}
DELETE /uploads/{upload_id}
GET /attachments
GET /attachments/{attachment_id}
GET /uploads
GET /uploads/{upload_id}
GET /webhook_delieveries/{webhook_delivery_id}
GET /webhook_deliveries
POST /attachments
POST /uploads
3 structure changes including:
1 Breaking change
3 Modifications
Modified 3 Breaking
GET /shipments/{shipment_id}
  • Response
  • 200 response Modified
    • eei_form_status property Added
PATCH /webhooks/{webhook_id}
  • Body
  • content type Added
POST /shipments
  • Response
  • 200 response Modified
    • eei_form_status property Added
2 structure changes including:
1 Breaking change
2 Modifications
Modified 2 Breaking
PATCH /webhooks/{webhook_id}
  • Body
  • content type Added
POST /requests
  • Header
  • Arta-Quote-Timeout header Added
3 structure changes including:
1 Breaking change
3 Modifications
Modified 3 Breaking
GET /shipments/{shipment_id}
  • Response
  • 200 response Modified
    • packages property Modified
PATCH /webhooks/{webhook_id}
  • Body
  • content type Added
POST /shipments
  • Response
  • 200 response Modified
    • packages property Modified
2 structure changes including:
1 Breaking change
2 Modifications
Modified 2 Breaking
PATCH /requests/{request_id}/custom
  • Body
  • content type Added
PATCH /webhooks/{webhook_id}
  • Body
  • content type Added