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
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 attributes Removed
        • Removing a resource is always breaking unless it was deprecated before

          Breaking

      • shipment attribute 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 attribute 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 attribute Added
POST /shipments
  • Response
  • 200 response Modified
    • application/json content type Modified
      • eei_form_url attribute Added
5 structure changes including:
5 Modifications
Modified 5
GET /requests/{request_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • objects attribute Modified
PATCH /requests/{request_id}/cancel
  • Response
  • 200 response Modified
    • application/json content type Modified
      • objects attribute Modified
PATCH /requests/{request_id}/contacts
  • Response
  • 200 response Modified
    • application/json content type Modified
      • objects attribute Modified
PATCH /requests/{request_id}/custom
  • Response
  • 200 response Modified
    • application/json content type Modified
      • objects attribute Modified
POST /requests
  • Response
  • 201 response Modified
    • application/json content type Modified
      • objects attribute Modified
2 structure changes including:
2 Modifications
Modified 2
GET /shipments/{shipment_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • packages attribute Modified
POST /shipments
  • Response
  • 200 response Modified
    • application/json content type Modified
      • packages attribute 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 attribute 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 attributes Added
GET /shipments/{shipment_id}
  • Response
  • 200 response Modified
    • emissions, emissions_unit, exceptions attributes Added
PATCH /organization
  • Body
  • content type Modified
    • webhook attribute Removed
    • organization attribute Added
  • Response
  • 200 response Modified
    • billing_terms, company_name, display_name, shortcode, status attributes Added
POST /shipments
  • Response
  • 200 response Modified
    • emissions, emissions_unit, exceptions attributes Added
8 structure changes including:
1 Addition
7 Modifications
Modified 7
GET /metadata/object_materials
GET /requests/{request_id}
  • Response
  • 200 response Modified
    • objects attribute Modified
PATCH /requests/{request_id}/cancel
  • Response
  • 200 response Modified
    • objects attribute Modified
PATCH /requests/{request_id}/contacts
  • Response
  • 200 response Modified
    • objects attribute Modified
PATCH /requests/{request_id}/custom
  • Response
  • 200 response Modified
    • objects attribute Modified
POST /hosted_sessions
  • Body
  • content type Modified
    • hosted_session attribute Modified
POST /requests
  • Body
  • content type Modified
    • request attribute Modified
  • Response
  • 201 response Modified
    • objects attribute 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 attribute Modified
PATCH /requests/{request_id}/cancel
  • Response
  • 200 response Modified
    • payment_process attribute Modified
PATCH /requests/{request_id}/contacts
  • Response
  • 200 response Modified
    • payment_process attribute Modified
PATCH /requests/{request_id}/custom
  • Response
  • 200 response Modified
    • payment_process attribute Modified
PATCH /webhooks/{webhook_id}
  • Body
  • content type Added
POST /requests
  • Response
  • 201 response Modified
    • payment_process attribute Modified
15 structure changes including:
1 Breaking change
1 Addition
14 Modifications
Modified 14 Breaking
GET /hosted_sessions
  • Response
  • 200 response Modified
    • items attribute Modified
GET /hosted_sessions/{hosted_session_id}
  • Response
  • 200 response Modified
    • origin attribute Modified
    • payment_process attribute Added
GET /requests
  • Response
  • 200 response Modified
    • items attribute Modified
GET /requests/{request_id}
  • Response
  • 200 response Modified
    • destination, origin attributes Modified
    • created_at, payment_process, updated_at attributes Added
GET /shipments
  • Response
  • 200 response Modified
    • items attribute Modified
GET /shipments/{shipment_id}
  • Response
  • 200 response Modified
    • destination, origin attributes Modified
    • created_at, package_count, payment_process, updated_at attributes Added
PATCH /hosted_sessions/{hosted_session_id}/cancel
  • Response
  • 200 response Modified
    • origin attribute Modified
    • payment_process attribute Added
PATCH /requests/{request_id}/cancel
  • Response
  • 200 response Modified
    • destination, origin attributes Modified
    • created_at, payment_process, updated_at attributes Added
PATCH /requests/{request_id}/contacts
  • Response
  • 200 response Modified
    • destination, origin attributes Modified
    • created_at, payment_process, updated_at attributes Added
PATCH /requests/{request_id}/custom
  • Response
  • 200 response Modified
    • destination, origin attributes Modified
    • created_at, payment_process, updated_at attributes Added
PATCH /webhooks/{webhook_id}
  • Body
  • content type Added
POST /hosted_sessions
  • Response
  • 201 response Modified
    • origin attribute Modified
    • payment_process attribute Added
POST /requests
  • Response
  • 201 response Modified
    • destination, origin attributes Modified
    • created_at, payment_process, updated_at attributes Added
POST /shipments
  • Response
  • 200 response Modified
    • destination, origin attributes Modified
    • created_at, package_count, payment_process, updated_at attributes 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 attribute Modified
PATCH /webhooks/{webhook_id}
  • Body
  • content type Added
POST /shipments
  • Response
  • 200 response Modified
    • tracking attribute Modified
4 structure changes including:
1 Breaking change
1 Addition
3 Modifications
Modified 3 Breaking
GET /shipments/{shipment_id}
  • Response
  • 200 response Modified
    • packages attribute Modified
PATCH /webhooks/{webhook_id}
  • Body
  • content type Added
POST /shipments
  • Response
  • 200 response Modified
    • packages attribute 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 attribute Added
PATCH /webhooks/{webhook_id}
  • Body
  • content type Added
POST /shipments
  • Response
  • 200 response Modified
    • eei_form_status attribute 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 attribute Modified
PATCH /webhooks/{webhook_id}
  • Body
  • content type Added
POST /shipments
  • Response
  • 200 response Modified
    • packages attribute 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
3 structure changes including:
1 Breaking change
2 Additions
1 Modification
Modified 1 Breaking
PATCH /webhooks/{webhook_id}
  • Body
  • content type Added
Added 2
PATCH /requests/{request_id}/cancel
PATCH /requests/{request_id}/custom