Supplier Shipping API

Supplier Shipping API

Suppliers who have their own workflow systems and don’t have OMS user accounts (e.g. those who use the Generic Filesystem supplier integrations) can now make use of OMS shipping integrations via a simple API.

The API allows a supplier to create a shipment with a carrier such as Hermes or Royal Mail for any order that the supplier has access to. On successful creation of the shipment, an address label from the carrier is returned back to the supplier.

 Only orders with a status of Received By Supplier can be shipped via the API.

Which orders a supplier has access to is determined via an order’s secondary company (which should be a dropship) and the company hierarchy.

For example, a supplier company with two dropships can use the API to ship any orders that has one of the dropships set as its secondary company.

The settings for the shipping carrier integration are derived from the dropship rather than the supplier itself. This makes it easy for the supplier to make use of different retailer provided shipping accounts (if required).

In order for the supplier to use the API, they need three pieces of information:

  • Their company reference ID
  • Their API key
  • The internal OMS ID of the order that they wish to ship (in the case of Generic Filesystem integrations, this can be found in the XML order data).

Further developer information can be found at https://developers-v2.custom-gateway.net/#order-shipping-api.


    • Related Articles

    • MWW Supplier Integration

      Overview It is now possible to send orders directly to the MWW On Demand platform via the new Custom Gateway supplier integration. If you would like to take advantage of this feature, please contact Custom Gateway Support quoting your MWW API key. ...
    • ShipStation API Shipping Integration

      OMS can integrate with the ShipStation shipping API so that when an item is dispatched using a scan point, a shipment is created in the ShipStation system and a shipping label for one of your enabled ShipStation carriers is generated . You must have ...
    • Royal Mail Shipping API Shipping Integration

      OMS is now able to integrate directly with Royal Mail’s shipping API so that when an item is dispatched using a scan point, a shipment is created in Royal Mail’s system and an official Royal Mail shipping label returned to the user. OMS will only ...
    • Order Push API - Generic API Supplier Integration

      The Order Push API from Custom Gateway us our generic OMS API allowing us to POST order data in JSON format (matching the structure of our standard orders in API) to an endpoint nominated by a supplier. This is a cheaper alternative to Custom Gateway ...
    • YourSurprise Supplier Integration

      This is a new Supplier Integration made to connect with the YourSurprise API. Settings Username & Password: These are YourSurprise specific settings, They should be provided by YourSurprise to the customer when they set up an account with ...