Changelog

v1 to v2

New Endpoints

    - POST /booking_amendments
    - GET /booking_line_items
    - POST /booking_line_items
    - GET /booking_line_items/{id}
    - GET /bookings
    - POST /bookings
    - GET /bookings/{id}
    - POST /carbon_calculation
    - GET /commercial_invoices
    - PATCH /commercial_invoices
    - POST /commercial_invoices
    - GET /commercial_invoices/{id}
    - GET /customs_entries
    - GET /customs_entries/{id}
    - GET /documents
    - POST /documents
    - GET /documents/{id}
    - GET /documents/{id}/download
    - GET /events
    - GET /events/{id}
    - GET /invoices/{id}
    - GET /network/companies
    - POST /network/companies
    - GET /network/companies/{id}
    - PATCH /network/companies/{id}
    - GET /network/company_entities
    - POST /network/company_entities
    - GET /network/company_entities/{id}
    - PATCH /network/company_entities/{id}
    - GET /network/contacts
    - POST /network/contacts
    - GET /network/contacts/{id}
    - PATCH /network/contacts/{id}
    - GET /network/locations
    - POST /network/locations
    - GET /network/locations/{id}
    - PATCH /network/locations/{id}
    - GET /network/me/companies
    - GET /ocean/shipment_container_legs
    - GET /ocean/shipment_container_legs/{id}
    - GET /ocean/shipment_containers
    - GET /ocean/shipment_containers/{id}
    - PATCH /products/{id}
    - GET /purchase_order_line_items
    - GET /purchase_order_line_items/{id}
    - GET /shipment_legs
    - GET /shipment_legs/{id}
    - PATCH /shipments/{id}
    - POST /shipments_shareable

Modified Endpoints

    - GET /invoices
      Parameters:
        - Added page
        - Added per
        - Added sort
        - Added direction
        - Added f.status
        - Added f.shipment.id
        - Added f.billed_directly_to_client
        - Added f.entity.id
        - Added f.entity.ref
        - Added f.name
        - Added f.issued_at.gt
        - Added f.issued_at.lt
        - Added f.last_updated_at.gt
        - Added f.last_updated_at.lt
        - Added f.client_id
        - Added f.shipment_id
        - Removed status
      Responses:
        - Modified 200
            - Added _object (string)
            - Added name (string)
            - Added issued_at (string) | format: date-time
            - Added quote_currency_code (string)
            - Added exchange_rate (number)
            - Added balance (object)
            - Added voided_at (string) | format: date-time
            - Added last_updated_at (string) | format: date-time
            - Added recipient (object)
            - Added issuer (object)
            - Added items (array)
            - Added notes (array)
            - Added credit_memos (array)
            - Added shipments (object)
            - Added total.properties (unknown type)
            - Removed invoice_id (string)
            - Removed first_shared_at (string)
            - Removed amount_paid (string)
            - Removed currency (string)
            - Removed shipment_id (integer)
            - Removed shipment_name (string)
            - Removed lines (array)
    - GET /ports
      Parameters:
        - Added f.port_type
        - Added f.unlocode
        - Modified page
        - Modified per
        - Removed q
        - Removed port_type
      Responses:
        - Modified 200
            - Added _object (string)
            - Added address (object)
            - Added details (array)
            - Removed id (integer)
            - Removed iata_code (string)
            - Removed lat (['string', 'null'])
            - Removed lng (['string', 'null'])
            - Removed port_name (string)
            - Removed country_code (string)
    - GET /products
      Parameters:
        - Added f.sku
        - Added f.archived_at.exists
        - Added f.product_properties.TYPE
      Responses:
        - Modified 200
            - Added _object (string)
            - Added archived_at (['string', 'null']) | format: date-time
            - Added product_category (string)
            - Added client_verified (boolean)
            - Added classifications (array)
            - Added product_properties.items (object)
            - Added hs_codes.items.properties._object (string)
            - Removed category (string)
    - POST /products
      Responses:
        - Modified 200
            - Added _object (string)
            - Added archived_at (['string', 'null']) | format: date-time
            - Added product_category (string)
            - Added client_verified (boolean)
            - Added classifications (array)
            - Added product_properties.items (object)
            - Added hs_codes.items.properties._object (string)
            - Removed category (string)
    - GET /products/{id}
      Responses:
        - Modified 200
            - Added _object (string)
            - Added archived_at (['string', 'null']) | format: date-time
            - Added product_category (string)
            - Added client_verified (boolean)
            - Added classifications (array)
            - Added product_properties.items (object)
            - Added hs_codes.items.properties._object (string)
            - Removed category (string)
    - GET /purchase_orders
      Parameters:
        - Added page
        - Added per
        - Added sort
        - Added direction
        - Added f.archived_at.exists
        - Added f.status
        - Added f.buyer_ref
        - Added f.seller_ref
        - Added f.role
        - Added f.shipment.id
        - Added f.name
        - Added f.updated_at.lt
        - Added f.updated_at.gt
        - Added f.created_at.lt
        - Added f.created_at.gt
      Responses:
        - Modified 200
            - Added _object (string)
            - Added buyer (object)
            - Added seller (object)
            - Added origin_port (['object', 'null'])
            - Added origin_address (object)
            - Added destination_port (['object', 'null'])
            - Added destination_address (object)
            - Added archived_at (string) | format: date_time
            - Added created_at (string) | format: date_time
            - Added updated_at (string) | format: date_time
            - Added line_items (object)
            - Added metadata (object)
            - Removed role (string) | enums: buyer, seller
            - Removed other_party_ref (string)
            - Removed currency_code (string)
            - Removed origin_port_ref (string)
            - Removed destination_port_ref (string)
            - Removed origin_location_ref (string)
            - Removed destination_location_ref (string)
            - Removed archived (boolean)
            - Removed po_line_items (array)
    - GET /purchase_orders/{id}
      Parameters:
        - Added f.purchase_order_version.id
        - Modified id (type string -> integer)
      Responses:
        - Modified 200
            - Added _object (string)
            - Added buyer (object)
            - Added seller (object)
            - Added origin_port (['object', 'null'])
            - Added origin_address (object)
            - Added destination_port (['object', 'null'])
            - Added destination_address (object)
            - Added archived_at (string) | format: date_time
            - Added created_at (string) | format: date_time
            - Added updated_at (string) | format: date_time
            - Added line_items (object)
            - Added metadata (object)
            - Removed role (string) | enums: buyer, seller
            - Removed other_party_ref (string)
            - Removed currency_code (string)
            - Removed origin_port_ref (string)
            - Removed destination_port_ref (string)
            - Removed origin_location_ref (string)
            - Removed destination_location_ref (string)
            - Removed archived (boolean)
            - Removed po_line_items (array)
    - GET /shipments
      Parameters:
        - Added f.transportation_mode
        - Added f.status
        - Added f.statuses.any
        - Added f.container_number
        - Added f.purchase_order
        - Added f.sku
        - Added f.updated_at.gt
        - Added f.updated_at.lt
        - Added f.archived_at.gt
        - Added f.archived_at.lt
        - Added f.master_bill_number
        - Added f.house_bill_number
        - Added f.consignee_external_ref
        - Added f.origin_address_ref
        - Added f.destination_address_ref
        - Added f.metadata.YOUR_METADATA_KEY
        - Added f.wants_freight_management_bco
        - Added f.wants_flexport_freight
        - Added f.wants_import_customs_service
        - Added f.wants_export_customs_service
        - Added f.wants_commercial_invoice_transcription
        - Added f.wants_flexport_insurance
        - Added f.wants_pickup_service
        - Added f.wants_trade_declaration_service
        - Added f.visibility_only
        - Added f.wants_delivery_service
        - Added f.belongs_to_a_buyers_consol
        - Modified sort (enum ['id', 'updated_at'] -> ['id', 'transportation_mode', 'status', 'updated_at', 'archived_at'])
        - Modified direction
        - Modified page
        - Modified per (type string -> integer)
        - Removed master_bill_number
        - Removed house_bill_number
      Responses:
        - Modified 200
            - Added metadata (object)
            - Added _object (string)
            - Added booking (object)
            - Added it_number (string)
            - Added created_date (string) | format: date-time
            - Added updated_at (string) | format: date-time
            - Added estimated_departure_date (string) | format: date-time
            - Added actual_departure_date (string) | format: date-time
            - Added estimated_arrival_date (string) | format: date-time
            - Added actual_arrival_date (string) | format: date-time
            - Added wants_freight_management_bco (boolean)
            - Added wants_flexport_freight (boolean)
            - Added wants_commercial_invoice_transcription (boolean)
            - Added wants_flexport_insurance (boolean)
            - Added wants_pickup_service (boolean)
            - Added wants_trade_declaration_service (boolean)
            - Added visibility_only (boolean)
            - Added wants_delivery_service (boolean)
            - Added wants_214_filing (boolean)
            - Added wants_ftz_entry (boolean)
            - Added belongs_to_a_buyers_consol (boolean)
            - Added child_shipments (array)
            - Added parent_shipment (object)
            - Added estimated_picked_up_in_full_date (string) | format: date-time
            - Added actual_picked_up_in_full_date (string) | format: date-time
            - Added estimated_delivered_in_full_date (string) | format: date-time
            - Added actual_delivered_in_full_date (string) | format: date-time
            - Added wants_export_customs_service (boolean)
            - Added wants_import_customs_service (boolean)
            - Added ocean_shipment (['object', 'null'])
            - Added air_shipment (['object', 'null'])
            - Added dangerous_goods (object)
            - Added accepted_quote (object)
            - Added quoted_transit_time_days_min (number)
            - Added quoted_transit_time_days_max (number)
            - Added quoted_delivery_date_from (string) | format: date-time
            - Added quoted_delivery_date_to (string) | format: date-time
            - Added shippers (array)
            - Added consignees (array)
            - Added buyers (array)
            - Added sellers (array)
            - Added importers_of_record (array)
            - Added items (array)
            - Added legs (object)
            - Added customs_entries (object)
            - Added documents (object)
            - Added picked_up_in_full_date (string) | format: date-time
            - Added delivered_in_full_date (string) | format: date-time
            - Added calculated_weight.properties (unknown type)
            - Added calculated_volume.properties (unknown type)
            - Added commercial_invoices.properties (unknown type)
            - Removed flex_id (string)
            - Removed master_bill_number (string)
            - Removed house_bill_number (string)
            - Removed metric_units (boolean)
            - Removed chargeable_weight (string)
            - Removed chargeable_volume (string)
            - Removed archived_at (['string', 'null']) | format: date-time
            - Removed total_weight (string)
            - Removed total_volume (string)
            - Removed origin_pickup_date (string) | format: date-time
            - Removed pickup_date (['string', 'null'])
            - Removed delivery_date (['string', 'null'])
            - Removed containers (array)
            - Removed graph (object)
            - Removed customs_cost (string)
            - Removed origin_address (string)
            - Removed destination_address (string)
            - Removed commercial_invoices.items (object)
    - GET /shipments/{id}
      Responses:
        - Modified 200
            - Added metadata (object)
            - Added _object (string)
            - Added booking (object)
            - Added it_number (string)
            - Added created_date (string) | format: date-time
            - Added updated_at (string) | format: date-time
            - Added estimated_departure_date (string) | format: date-time
            - Added actual_departure_date (string) | format: date-time
            - Added estimated_arrival_date (string) | format: date-time
            - Added actual_arrival_date (string) | format: date-time
            - Added wants_freight_management_bco (boolean)
            - Added wants_flexport_freight (boolean)
            - Added wants_commercial_invoice_transcription (boolean)
            - Added wants_flexport_insurance (boolean)
            - Added wants_pickup_service (boolean)
            - Added wants_trade_declaration_service (boolean)
            - Added visibility_only (boolean)
            - Added wants_delivery_service (boolean)
            - Added wants_214_filing (boolean)
            - Added wants_ftz_entry (boolean)
            - Added belongs_to_a_buyers_consol (boolean)
            - Added child_shipments (array)
            - Added parent_shipment (object)
            - Added estimated_picked_up_in_full_date (string) | format: date-time
            - Added actual_picked_up_in_full_date (string) | format: date-time
            - Added estimated_delivered_in_full_date (string) | format: date-time
            - Added actual_delivered_in_full_date (string) | format: date-time
            - Added wants_export_customs_service (boolean)
            - Added wants_import_customs_service (boolean)
            - Added ocean_shipment (['object', 'null'])
            - Added air_shipment (['object', 'null'])
            - Added dangerous_goods (object)
            - Added accepted_quote (object)
            - Added quoted_transit_time_days_min (number)
            - Added quoted_transit_time_days_max (number)
            - Added quoted_delivery_date_from (string) | format: date-time
            - Added quoted_delivery_date_to (string) | format: date-time
            - Added shippers (array)
            - Added consignees (array)
            - Added buyers (array)
            - Added sellers (array)
            - Added importers_of_record (array)
            - Added items (array)
            - Added legs (object)
            - Added customs_entries (object)
            - Added documents (object)
            - Added picked_up_in_full_date (string) | format: date-time
            - Added delivered_in_full_date (string) | format: date-time
            - Added calculated_weight.properties (unknown type)
            - Added calculated_volume.properties (unknown type)
            - Added commercial_invoices.properties (unknown type)
            - Removed flex_id (string)
            - Removed master_bill_number (string)
            - Removed house_bill_number (string)
            - Removed metric_units (boolean)
            - Removed chargeable_weight (string)
            - Removed chargeable_volume (string)
            - Removed archived_at (['string', 'null']) | format: date-time
            - Removed total_weight (string)
            - Removed total_volume (string)
            - Removed origin_pickup_date (string) | format: date-time
            - Removed pickup_date (['string', 'null'])
            - Removed delivery_date (['string', 'null'])
            - Removed containers (array)
            - Removed graph (object)
            - Removed customs_cost (string)
            - Removed origin_address (string)
            - Removed destination_address (string)
            - Removed commercial_invoices.items (object)

Removed Endpoints

    - GET /currency_codes
    - GET /network
    - POST /network
    - PATCH /network/{id}
    - POST /network/{id}/create_address
    - DELETE /products/{id}
    - POST /products/{id}
    - POST /purchase_orders
    - GET /quote_requests/{id}