Sandbox
      Back to home
      1. Knowledge Base
      2. Sandbox

      Sandbox - Development API Requirements

      Please ensure, as a minimum, to have the below API calls developed before going live:

      1. createShipment - used to generate the final delivery label(s) for your packages.
      2. cancelShipment - used to cancel/ void a current shipping label. 
      3. confirmShipment- used to closeout shipments, which produces the collection manifest to be handed over to the driver and may trigger electronic pre-advice and billing data to be sent to the carrier.
        See below documents for more information on manifesting:
        - Shipment Closeout Quick Reference Guide
        - Royal Mail Closeout
        - Clean Sweep functionality
      4. createContainer - used to create a new container and allocate shipments to the
        container. This is API call is relevant to Royal Mail Freight 2 Post customers only, and it must be used instead of confirmShipment API.