GoSweetSpot: Publish Manifest

GoSweetSpot: Publish Manifest

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..."
]

    • Related Articles

    • GoSweetSpot: API introduction

      In this Documentation: Authentication Rate Limiting Sandbox Account Data Types and Formats Concepts Common Use Cases Endpoints Tracing Your Calls FAQ Freight API provides programmatic access to GSS functionality and content. The API is REST API and ...

    • GoSweetSpot: Models

      Available Rate Model Attribute Type Description quoteId Guid Unique rates calculation identifier. carrierId integer Id of carrier. carriername string Display name of courier provider. deliverytype string Courier delivery/service type. cost decimal ...

    • GoSweetSpot: Book a Pickup

      Description Query to book a driver to pick up from your location. They will make a best effort attempt to pick up on the same day - however, if you book after 2PM it is recommended that you book again in the morning if they don't pick up on the same ...

    • GoSweetSpot: Customer Orders

      Get the list of Customer Orders Description Get the list of customer orders published in the queue. You can filter on processed or non-processed. Requests Method: GET Content Type: application/json URL: ...

    • GoSweetSpot: Labels

      Labels in Queue Description Queue a provided image file for printing via the print application. Requests Method: POST Content Type: application/json URL: https://api-docs.gosweetspot.com/docs/labels/post.html Headers access_key : your unique API key ...