Skip to main content

Customer Portal: new API endpoints and new fields of the Order object

The API endpoints are available that enables API customers to manage customers, terminals, and contacts with more flexibility. These endpoints are replacing the old (now deprecated) Contacts API. Customers and terminals can be reused while creating an order. Each customer or terminal can have several contacts. Only one contact can be marked as primary.

API reference: Customers, Terminals.

These changes add new fields to the Order object.

...
"pickup_counterparty_guid": "ef2818b8-a55e-436a-a61e-993ae0470928",
"save_as_new": null,
"save_as_new_contact": null,
"venue": {
"name": "First Choice",
"business_type": "DEALER",
"address": "7997 Hudson Street",
"city": "Suffolk",
"state": "VA",
"zip": "23434",
"contact_name": "Patricia Bennett",
"contact_title": "Dispatcher",
"contact_email": "[email protected]",
"contact_phone": "215-800-1859",
"contact_mobile_phone": "412-452-2889"
},
...
  • pickup and delivery:
    • counterparty_guid to reuse customer or terminal information
    • save_as_new and save_as_new_contact to save customer, terminal, or contact information
  • pickup.venue and delivery.venue:
    • business_type can accept the values DEALER, PRIVATE, AUCTION, REPO_YARD, PORT, BUSINESS
    • contact_title
    • contact_mobile_phone

API reference: create a new order.

The field "active" is deprecated

Some endpoints of Shipper API return two fields: active and is_active. Both fields are boolean, and they indicate the object is active, not deleted.

active is deprecated now. API clients should use only is_active from now. We'll remove active from Shipper API on February 7, 2020. The field is marked as deprecated in the API reference already.

Domain migration: api.broker.superdispatch.org to api.shipper.superdispatch.com

Currently our API works on two subdomains:

  • api.broker.superdispatch.org
  • api.shipper.superdispatch.com

We're going to shut down the first domain on January 31, 2020. After this date all requests should be sent to api.shipper.superdispatch.com. Our documentation and API reference already use the second domain.

Contacts API endpoints shut down by January 31, 2020

The Contacts API endpoints in Shipper API shut down by January 31, 2020. They're deprecated now. Please use Customers and Terminals instead.

Currently our team are working on a more advanced feature that will replace Contacts. We'll make another announcement when the new API endpoints are ready.