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
2 structure changes including:
1 Breaking change
1 Modification
1 Removal
Modified 1 Breaking
POST /self_ship_collections
  • Body
  • application/json content type Modified
    • self_ship_collection property Modified
      • location property Modified
        • package_location property Modified
          • Property is now required
            Breaking
      • service property Modified
        • package_details property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
Removed 1 Breaking
PATCH /self_ship_collections/{self_ship_collection_id}/cancel
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
2 structure changes including:
1 Addition
1 Modification
Modified 1
POST /self_ship_collections
  • Body
  • application/json content type Modified
    • self_ship_collection property Modified
      • location property Modified
        • package_location property Modified
          • Property is no longer required
      • service property Modified
        • package_details property Added
Added 1
PATCH /self_ship_collections/{self_ship_collection_id}/cancel
3 structure changes including:
3 Additions
Added 3
GET /metadata/insurance_policy_booking_disqualifications
GET /metadata/insurance_policy_coverage_types
GET /metadata/insurance_policy_statuses
4 structure changes including:
4 Additions
Added 4
DELETE /collection_tag_rules/{collection_tag_rule_id}
GET /collection_tag_rules
GET /collection_tag_rules/{collection_tag_rule_id}
POST /collection_tag_rules
2 structure changes including:
2 Modifications
Modified 2
GET /shipments/{shipment_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • in_transit_at, collected_at, confirmed_at, cancelled_at, completed_at properties Added
POST /shipments
  • Response
  • 201 response Modified
    • application/json content type Modified
      • in_transit_at, collected_at, confirmed_at, cancelled_at, completed_at properties Added
3 structure changes including:
3 Modifications
Modified 3 Breaking
GET /import_cost_estimates
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • estimate property Modified
        • quote_id property Added
GET /import_cost_estimates/{import_cost_estimate_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • estimate property Modified
        • summary property Modified
      • quote_id property Added
POST /import_cost_estimates
  • Body
  • application/json content type Modified
    • alternative Modified
      • ImportCostEstimateCreate alternative Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • DirectImportCostEstimatePayload, ImportCostEstimateFromQuotePayload alternatives Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • estimate property Modified
        • summary property Modified
      • quote_id property Added
10 structure changes including:
10 Modifications
Modified 10
GET /hosted_sessions/{hosted_session_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • customs_end_use, customs_process properties Added
GET /requests/{request_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • customs_end_use, customs_process properties Added
GET /shipments/{shipment_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • customs_end_use, customs_process properties Added
PATCH /hosted_sessions/{hosted_session_id}/cancel
  • Response
  • 200 response Modified
    • application/json content type Modified
      • customs_end_use, customs_process properties Added
PATCH /requests/{request_id}/cancel
  • Response
  • 200 response Modified
    • application/json content type Modified
      • customs_end_use, customs_process properties Added
PATCH /requests/{request_id}/contacts
  • Response
  • 200 response Modified
    • application/json content type Modified
      • customs_end_use, customs_process properties Added
PATCH /requests/{request_id}/custom
  • Response
  • 200 response Modified
    • application/json content type Modified
      • customs_end_use, customs_process properties Added
POST /hosted_sessions
  • Body
  • application/json content type Modified
    • alternative Modified
      • BookingSession alternative Modified
        • hosted_session property Modified
      • InboundBookingSession alternative Modified
        • hosted_session property Modified
  • Response
  • 201 response Modified
    • application/json content type Modified
      • customs_end_use, customs_process properties Added
POST /requests
  • Body
  • application/json content type Modified
    • request property Modified
      • customs_end_use, customs_process properties Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • customs_end_use, customs_process properties Added
POST /shipments
  • Body
  • application/json content type Modified
    • alternative Modified
      • ArtaShipmentPayload alternative Modified
        • shipment property Modified
  • Response
  • 201 response Modified
    • application/json content type Modified
      • customs_end_use, customs_process properties Added
1 structure change including:
1 Modification
Modified 1
POST /shipments
  • Body
  • application/json content type Modified
    • alternative Modified
      • ArtaShipmentPayload alternative Modified
        • shipment property Modified
4 structure changes including:
4 Additions
Added 4
GET /self_ship_collections
GET /self_ship_collections/{self_ship_collection_id}
POST /self_ship_collection_availability_checks
POST /self_ship_collections
3 structure changes including:
3 Additions
Added 3
GET /address_verifications
GET /address_verifications/{address_verification_id}
POST /address_verifications
7 structure changes including:
7 Modifications
Modified 7 Breaking
GET /requests
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • tags property Added
GET /requests/{request_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tags property Added
GET /shipments
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • tags property Modified
          • Type went from array[string] to array[object]
            Breaking
PATCH /requests/{request_id}/cancel
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tags property Added
PATCH /requests/{request_id}/contacts
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tags property Added
PATCH /requests/{request_id}/custom
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tags property Added
POST /requests
  • Response
  • 201 response Modified
    • application/json content type Modified
      • tags property Added
4 structure changes including:
4 Modifications
Modified 4
GET /hosted_sessions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • type property Added
GET /hosted_sessions/{hosted_session_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • type property Added
PATCH /hosted_sessions/{hosted_session_id}/cancel
  • Response
  • 200 response Modified
    • application/json content type Modified
      • type property Added
POST /hosted_sessions
  • Response
  • 201 response Modified
    • application/json content type Modified
      • type property Added
4 structure changes including:
4 Modifications
Modified 4
GET /hosted_sessions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • can_user_confirm_object_dimensions, quoting_strategy properties Added
GET /hosted_sessions/{hosted_session_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • can_user_confirm_object_dimensions, public_instructions_booking_review, public_instructions_confirmation, public_instructions_location_quotes, public_instructions_object_details, public_instructions_payment, quoting_strategy properties Added
PATCH /hosted_sessions/{hosted_session_id}/cancel
  • Response
  • 200 response Modified
    • application/json content type Modified
      • can_user_confirm_object_dimensions, public_instructions_booking_review, public_instructions_confirmation, public_instructions_location_quotes, public_instructions_object_details, public_instructions_payment, quoting_strategy properties Added
POST /hosted_sessions
  • Body
  • application/json content type Modified
    • BookingSession alternative Modified
      • hosted_session property Modified
        • public_instructions_booking_review, public_instructions_confirmation, public_instructions_location_quotes, public_instructions_payment, quoting_strategy, type properties Added
    • InboundBookingSession alternative Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • can_user_confirm_object_dimensions, public_instructions_booking_review, public_instructions_confirmation, public_instructions_location_quotes, public_instructions_object_details, public_instructions_payment, quoting_strategy properties Added
12 structure changes including:
1 Addition
11 Modifications
Modified 11
GET /hosted_sessions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • objects property Modified
GET /hosted_sessions/{hosted_session_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • objects property Modified
        • components, type properties Added
GET /requests/{request_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • objects property Modified
        • components, type properties Added
GET /shipments/{shipment_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • packages property Modified
        • objects property Modified
PATCH /hosted_sessions/{hosted_session_id}/cancel
  • Response
  • 200 response Modified
    • application/json content type Modified
      • objects property Modified
        • components, type properties Added
PATCH /requests/{request_id}/cancel
  • Response
  • 200 response Modified
    • application/json content type Modified
      • objects property Modified
        • components, type properties Added
PATCH /requests/{request_id}/contacts
  • Response
  • 200 response Modified
    • application/json content type Modified
      • objects property Modified
        • components, type properties Added
PATCH /requests/{request_id}/custom
  • Response
  • 200 response Modified
    • application/json content type Modified
      • objects property Modified
        • components, type properties Added
POST /hosted_sessions
  • Body
  • application/json content type Modified
    • BookingSession alternative Modified
      • hosted_session property Modified
        • objects property Modified
  • Response
  • 201 response Modified
    • application/json content type Modified
      • objects property Modified
        • components, type properties Added
POST /requests
  • Body
  • application/json content type Modified
    • request property Modified
      • objects property Modified
        • components property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • objects property Modified
        • components, type properties Added
POST /shipments
  • Body
  • application/json content type Modified
    • TrackShipmentPayload alternative Modified
      • shipment property Modified
        • packages property Modified
  • Response
  • 201 response Modified
    • application/json content type Modified
      • packages property Modified
        • objects property Modified
Added 1
GET /metadata/object_components
13 structure changes including:
1 Addition
12 Modifications
Modified 12 Breaking
GET /hosted_sessions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • objects property Modified
GET /hosted_sessions/{hosted_session_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • objects property Modified
        • customs property Added
GET /requests
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • quoting_strategy property Added
GET /requests/{request_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • objects property Modified
        • details property Modified
        • internal_reference, public_reference properties Modified
          • Type went from string | null to string
            Breaking
        • type property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • customs property Added
      • quoting_strategy property Added
GET /shipments/{shipment_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • packages property Modified
        • objects property Modified
PATCH /hosted_sessions/{hosted_session_id}/cancel
  • Response
  • 200 response Modified
    • application/json content type Modified
      • objects property Modified
        • customs property Added
PATCH /requests/{request_id}/cancel
  • Response
  • 200 response Modified
    • application/json content type Modified
      • objects property Modified
        • details property Modified
        • internal_reference, public_reference properties Modified
          • Type went from string | null to string
            Breaking
        • type property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • customs property Added
      • quoting_strategy property Added
PATCH /requests/{request_id}/contacts
  • Response
  • 200 response Modified
    • application/json content type Modified
      • objects property Modified
        • details property Modified
        • internal_reference, public_reference properties Modified
          • Type went from string | null to string
            Breaking
        • type property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • customs property Added
      • quoting_strategy property Added
PATCH /requests/{request_id}/custom
  • Response
  • 200 response Modified
    • application/json content type Modified
      • objects property Modified
        • details property Modified
        • internal_reference, public_reference properties Modified
          • Type went from string | null to string
            Breaking
        • type property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • customs property Added
      • quoting_strategy property Added
POST /hosted_sessions
  • Body
  • application/json content type Modified
    • BookingSession alternative Modified
      • hosted_session property Modified
        • objects property Modified
  • Response
  • 201 response Modified
    • application/json content type Modified
      • objects property Modified
        • customs property Added
POST /requests
  • Body
  • application/json content type Modified
    • request property Modified
      • objects property Modified
        • customs property Added
      • quoting_strategy property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • objects property Modified
        • details property Modified
        • internal_reference, public_reference properties Modified
          • Type went from string | null to string
            Breaking
        • type property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • customs property Added
      • quoting_strategy property Added
POST /shipments
  • Body
  • application/json content type Modified
    • TrackShipmentPayload alternative Modified
      • shipment property Modified
        • packages property Modified
  • Response
  • 201 response Modified
    • application/json content type Modified
      • packages property Modified
        • objects property Modified
Added 1
GET /metadata/quoting_strategies
2 structure changes including:
2 Modifications
Modified 2
GET /shipments/{shipment_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • tracking property Modified
        • label_format_urls property Added
POST /shipments
  • Response
  • 201 response Modified
    • application/json content type Modified
      • tracking property Modified
        • label_format_urls property Added
9 structure changes including:
9 Modifications
Modified 9
GET /hosted_sessions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • preferred_parcel_transport_services property Added
GET /hosted_sessions/{hosted_session_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • preferred_parcel_transport_services property Added
GET /requests/{request_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • preferred_parcel_transport_services property Added
PATCH /hosted_sessions/{hosted_session_id}/cancel
  • Response
  • 200 response Modified
    • application/json content type Modified
      • preferred_parcel_transport_services property Added
PATCH /requests/{request_id}/cancel
  • Response
  • 200 response Modified
    • application/json content type Modified
      • preferred_parcel_transport_services property Added
PATCH /requests/{request_id}/contacts
  • Response
  • 200 response Modified
    • application/json content type Modified
      • preferred_parcel_transport_services property Added
PATCH /requests/{request_id}/custom
  • Response
  • 200 response Modified
    • application/json content type Modified
      • preferred_parcel_transport_services property Added
POST /hosted_sessions
  • Body
  • application/json content type Modified
    • BookingSession alternative Modified
      • hosted_session property Modified
        • preferred_parcel_transport_services property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • preferred_parcel_transport_services property Added
POST /requests
  • Body
  • application/json content type Modified
    • request property Modified
      • preferred_parcel_transport_services property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • preferred_parcel_transport_services property Added
1 structure change including:
1 Modification
Modified 1 Breaking
POST /hosted_sessions
  • Body
  • application/json content type Modified
    • BookingSession alternative Modified
      • hosted_session property Modified
        • objects, origin properties Modified
          • Properties are now required
            Breaking
1 structure change including:
1 Modification
Modified 1 Breaking
POST /import_cost_estimates
  • Body
  • application/json content type Modified
    • import_cost_estimate property Modified
      • destination property Modified
        • country property Modified
          • Property is now required
            Breaking
      • objects property Modified
        • hs_code, value, value_currency properties Modified
          • Properties are now required
            Breaking
        • quantity property Added
      • origin property Modified
        • country property Modified
          • Property is now required
            Breaking
      • transport property Modified
        • amount, amount_currency, service_level properties Modified
          • Properties are now required
            Breaking
3 structure changes including:
3 Additions
Added 3
GET /import_cost_estimates
GET /import_cost_estimates/{import_cost_estimate_id}
POST /import_cost_estimates