Skip to main content

v2/publishmanifest

Less than 1 minute

v2/publishmanifest

Description

This function accepts as input all pending consignments that are ready for manifesting. These consignmnets are manifested to their respective carriers and a summary manifest report is returned as a PDF.

This method will accept consignment numbers as an array.

Request

  • Method: POST
  • Content Type: application/json
  • URL: https://api.gosweetspot.com/v2/publishmanifest

Headers

  • access_key : your unqiue api key provided by GSS.
  • site_id : which site you are requesting action for.

Parameters

The body of the message should be sent as an JSON array.

A list of consignment numbers.

Return format

JSON object array per manifest generated. This is in a key/value pair collection, with the manifest number being the key and value is the base64 encoded byte stream of the PDF.

Errors

HTTP 400.Bad request - when no consignment numbers supplied or when invalid consignment numbers supplied.

Request example

curl --location --request POST 'https://api.gosweetspot.com/v2/publishmanifest' \
--header 'access_key;' \
--header 'site_id;' \
--header 'Content-Type: application/json' \
--data '[
	"4WD0002186",
	"4WD0002187",
	"4WD0002188"
]'

Response example

Binary blocks below have been trimmed for presentation.

[
    "iVBORw0KGgoAAAANSUhEUgAABUYAAAMHCAYAAAD1lY2SAAAAAXNS...",
    "iVBORw0KGgoAAAANSUhEUgAABUYAAAMHCAYAAAD1lY2SMAAA7DAc...",
    "iVBORw0KGgoAAAANSUhEUgAABUYAAAMHCAlSURBVHhe7P0J9GXXl..."
]
Last update: