Manifest

Organise and facilitate the courier pick-up

When parcels are ready for remittance to the courier, a close-out call can be made to notify Glopal with the list of parcels ready for shipping. Glopal produces a manifest and other consolidated shipping documents for the carrier, and activates tracking.

Prepare remittance of parcels to carrier(s)

POSThttps://ws.xport.glopalservice.com/ops/closeout

Header parameters

Body

application/jsonapplication/xml

async_modeall of

Process closeout operation in asynchronous mode, default is false

Example: 0

awbstring

Airway Bill number (Carrier tracking reference)

Example: "AWB1234567890_23"

Pattern: ^.{0,255}$

dry_runall of

Process closeout operation without effect on packages, default is false

Example: 0

fulfillment_idone of

stringarray of string

order_referenceone of

stringarray of string

podone of

integerarray of integer

referenceone of

Merchant closeout reference

Example: "MERCHREF123"

stringarray of string

wms_idone of

stringarray of string

Response

200

OK

Body

application/jsonapplication/xml

request_idnumber (integer)

Example: 1234567

closeoutarray of object

Results per closeout

excluded_ordersobject

Orders that cannot be part of the closeout scope

error*enum

Operation success outcome

Example: 0

10

errorsarray of object

List of errors (if operation was not successful)

warningsarray of object

List of warnings

Request

JSPy

const timestamp = String(Date.now() / 1000).padEnd(17, '0');
const username = "username";
const signature = CryptoJS.HmacSHA256(
  `${username}@${timestamp}`, "sharedsecret"
  ).toString(CryptoJS.digest)

const response = await fetch('https://ws.xport.glopalservice.com/ops/closeout', {
  method: 'POST',
  headers: {
    "Content-Type": "application/json",
    "x-login": username,
    "x-timestamp": timestamp,
    "x-signature": signature
  },
  body: JSON.stringify({
    "wms_id": "WMS12345"
  })
});
const data = await response.json();

Response

200

{
  "error": 0,
  "closeout": [
    {
      "closeout_reference": 123456,
      "delivery_type_id": "X",
      "documents": [
        {
          "type": "doc_type",
          "url": "https://test.xport.glopalservice.com/test"
        }
      ],
      "fulfillment_id": "FU.123OMS",
      "manifest_url": "https://test.xport.glopalservice.com/test",
      "manifest_url_pdf": "https://test.xport.glopalservice.com/test",
      "order_reference": [
        "test123"
      ],
      "wms_id": [
        "WMS12345"
      ]
    }
  ],
  "excluded_orders": {
    "country": "US",
    "delivery_type_id": "X",
    "exclusion_code": "ISSUE_CODE",
    "order_reference": "test123",
    "wms_id": "WMS12345",
    "fulfillment_id": "FU.123OMS"
  }
}