The order API now supports shipping maps.

Shipping maps can be set against a company via the API & Incoming tab of the v2 Company Settings section.

The shipping map set on the order’s secondary company has priority over the shipping map set against the order’s primary company.

Each shipping map entry contains a From Carrier and From Method field.

When an order is created via the API, each shipping map entry will be tested to see weather the From Carrier and From Method fields match the order’s Shipping Carrier and Shipping Method fields.

If a match is found, the order’s Shipping Carrier and Shipping Method fields will be set to the values of the To Carrier and To Method fields on the shipping map entry.

Note that the values are case and white-space sensitive. Blank values can be mapped if required.

API shipping maps are only available with the new API URL:

https://api-sl-2-1.custom-gateway.net/order

It is not available on the legacy URL:

https://my.gateway3d.com/acp/api/sl/2.1/order

Integrations

The following integrations can also make use of the company shipping map:

  • Prezzybox (Retailer)
  • Standard CSV (Retailer)
  • Oracle Locate (Retailer)
  • Scalable Press (Supplier)
  • District Photo (Supplier)

More integrations will be updated to support company shipping maps in the future.

The company shipping map always takes priority over the integration’s legacy shipping map.

As with the legacy shipping maps, a supplier integration will never update the order’s Shipping Carrier and Shipping Method fields. A supplier integration will only map the value that is sent to the supplier.