logo

Help Centre

ProductsOpen in new tab DeveloperOpen in new tab Release NotesOpen in new tab Submit a requestOpen in new tab
How can we help?

SOAP Shipping API

  • Getting Started

    How to get up and running with the Shipping SOAP API.

    • Introduction to the SOAP Shipping API
    • Creating your API User
    • Creating a SOAP Project from a Service
    • Creating your first Request to a Service
  • Quick Start

    A quick start API sequence including Postman collections.

    • SOAP Shipping API Postman Collection
    • From Pre-Ship through to Manifesting
  • Best Practices for different Workflows

    Recommended API calls for common uses.

    • Summary
    • Basic Shipping
    • Ship and Hold
    • Pre-Ship Picking Optimisation
    • Rate Shopping
    See all 8 articles
  • Consignment Building Blocks

    The constituent parts of the Shipping SOAP API.

    • Properties needed to Call or Create a Consignment
    • Parcels Array
    • Products Array
  • Allocation Building Blocks

    How to allocate a consignment.

    • Booking Codes and the Allocation Filter
    • Filtering and Sorting
  • Printing (Despatch) Building Blocks

    How to generate labels and customs documents.

    • Printing Properties
  • Allocation Service

    How to create, allocate and despatch consignments.

    • Allocation Service Methods
    • allocateConsignments
    • allocateConsignmentsWithBookingCode
    • createAndAllocateConsignments
    • createAndAllocateConsignmentsWithBookingCode
    See all 12 articles
  • Debug Service

    API version of the 'Why Not?' feature.

    • Debug Service Methods
    • debugConsignmentWhyNot
    • debugConsignmentWhyNotWithBookingCode
  • Consignment Service

    How to manage consignments using the API.

    • Consignment Service Methods
    • addConsignmentsToGroup
    • addInnerToOuter
    • appendParcelsToConsignment
    • createConsignments
    See all 22 articles
  • Consignment Search Service

    How to search for consignments using the API.

    • Consignment Search Service Methods
    • findConsignmentsByCarrierConsignmentCode
    • findConsignmentsByCartonId
    • findConsignmentByConsignmentCode
    • findConsignmentsByOrderReference
    See all 6 articles
  • Manifest Service

    How to manifest using the API.

    • Manifest Service Methods
    • createManifest
    • createManifestAsPdf
    • createManifestForFutureDespatch
    • findConsignmentsOnManifest
    See all 7 articles
  • Information Service

    How to return config. information using the API.

    • Information Service Methods
    • findCarriers
    • findCarrierServices
    • findGroups
    • findServicesInGroups
    See all 6 articles
  • SOAP API Error Codes

    Possible SOAP Error Codes

    • Possible Error Codes
  • Migrating to REST API

    Learn about migrating from SOAP API to REST Shipping API.

    • SOAP-REST API migration
  • FAQs

    Common questions on features offered by the API.

    • How do I Print and Manifest separately?
    • How do I tell a carrier that a product contains Dangerous Goods?
    • How do I create consignments in Imperial Weights and Measures?
    • How do I specify a what3words location?

    Featured Articles

    • Promoted article
      What Brexit means for you

    Couldn't find what you're looking for?

    Contact us
    Sign in

    © Metapack