Included in this document:

• Description
• Requests
• Headers
• Parameters
• Return format
• Errors
• Request example
• Response example

Description

This function accepts as input all pending consignments that are ready for manifesting. These consignments 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.

Requests

Method: POS
Content Type: application/json
URL: https://api-docs.gosweetspot.com/docs/publish-manifest/v2-publishmanifest.html

Headers

access_key : your unique API key provided by GSS.
site_id : which site you are requesting action for.

Parameters

The body of the message should be sent as a 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 the value being the base64 encoded byte stream of the PDF.

Errors

HTTP 400. Bad request - when no consignment numbers or invalid consignment numbers are 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

[
    "iVBORw0KGgoAAAANSUhEUgAABUYAAAMHCAYAAAD1lY2SAAAAAXNS...",
    "iVBORw0KGgoAAAANSUhEUgAABUYAAAMHCAYAAAD1lY2SMAAA7DAc...",
    "iVBORw0KGgoAAAANSUhEUgAABUYAAAMHCAlSURBVHhe7P0J9GXXl..."
]