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)

post

https://ws.xport.glopalservice.comhttps://ws.stg.xport.glopalservice.com

/ops/closeout

Header parameters

x-loginstringRequired

Client username (set by Glopal)

Example: usernamePattern: ^[a-z0-9\-]{3,255}$

x-aliasstringOptional

Optional system username to enable separation of authentication credentials by integrated client system. (set by Glopal)

Example: alias-usernamePattern: ^[a-z0-9\-]{3,50}$

x-signaturestringRequired

The authentication signature is created by using the concatenation of the login, the ‘@’ sign and the timestamp, transformed into a HMAC_256 signature using your secret access key.

Example: 40b976b35a08bb951439ea7bbfa0a7bd73dab7c813399a31d9d1a157bc08929bPattern: ^[0-9a-f]{64}$

x-timestampnumber · floatRequired

The authentication timestamp must be a decimal numeric representing the current POSIX time, extended to microsecond accuracy. If the requesting system does not provide high-resolution time, it is advised to use a 6-digit random number. It is important to have the requesting system synchronised with a reliable time source (f.i. a stratum 2 NTP server) to avoid request rejection.

Example: 1680010295.775523Pattern: ^[12]\d{9}\.\d{6}$

x-versionnumber · floatOptionalDefault: 0.68Pattern: (^0\.\d{2}$|^[1-9]\d*\.\d{2}$)

Body

application/jsonapplication/xml

At least one of awb, fulfillment_id, order_reference, pod, reference and wms_id is required

async_modeall ofOptional

Process closeout operation in asynchronous mode, default is false

Example: 0

anyOptional

integer · enumOptional

with application/xml

Example: 1Possible values:

or

boolean · enumOptional

with application/json

Example: truePossible values:

awbstringOptional

Airway Bill number (Carrier tracking reference)

Example: AWB1234567890_23Pattern: ^.{0,255}$

dry_runall ofOptional

Process closeout operation without effect on packages, default is false

Example: 0

anyOptional

integer · enumOptional

with application/xml

Example: 1Possible values:

or

boolean · enumOptional

with application/json

Example: truePossible values:

fulfillment_idone ofOptional

stringOptional

OMS order fulfillment identifier

Example: FU.123OMSPattern: .{0,100}$

or

string[] · min: 1 · max: 1000Optional

OMS order fulfillment identifier

Example: FU.123OMS

order_referenceone ofOptional

stringOptional

Merchant/Seller order reference

Example: test123Pattern: ^.{3,255}$

or

string[] · min: 1 · max: 1000Optional

Merchant/Seller order reference

Example: test123

podone ofOptional

integer · min: 1Optional

Pod entity (package grouping) identifier

or

integer[] · min: 1 · max: 1000Optional

Pod entity (package grouping) identifier

referenceone ofOptional

Merchant closeout reference

Example: MERCHREF123

stringOptional

Merchant/Seller order reference

Example: test123Pattern: ^.{3,255}$

or

string[] · min: 1 · max: 1000Optional

Merchant/Seller order reference

Example: test123

wms_idone ofOptional

stringOptional

Warehouse Manament System package identifier

Example: WMS12345Pattern: ^.{0,255}$

or

string[] · min: 1 · max: 1000Optional

Warehouse Manament System package identifier

Example: WMS12345

Responses

200

OK

application/jsonapplication/xml

400

Bad Request

application/jsonapplication/xml

401

Unauthorized

application/jsonapplication/xml

403

Forbidden

application/jsonapplication/xml

404

Not found

application/jsonapplication/xml

405

Method not allowed

application/jsonapplication/xml

500

Internal server error

application/jsonapplication/xml

503

Service unavailable

application/jsonapplication/xml

post

/ops/closeout

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();

{
  "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"
  }
}