Last updated

Submit a document

As a Shipper, submit a document to project44’s documents service.

Requirements

On top of submitting a document (in one the following formats: "PDF", "PNG", "JPEG", "GIF", "TIF"), the following data points are expected:

  • Document name
  • Document type (e.g. “PROOF_OF_DELIVERY”)
  • Shipment identifiers that help us identify which shipment the document belongs to (e.g. a BILL_OF_LADING number and a CARRIER_SCAC)

Workflow

Complete these steps:

  1. Prepare a POST request to /services/document/v1/documents.
  2. Add the document and required information to the request schema.
JSON
{
  "name": "document_name",
  "type": "PROOF_OF_DELIVERY",
  "identifiers": [
    {
      "type": "BILL_OF_LADING",
      "value": "123456"
    },
    {
      "type": "CARRIER_SCAC",
      "value": "ABCD"
    }
  ]
}

This is an example of a potential request. For the full request schema and descriptions for all fields and objects, please refer to the API documentation: POST /services/document/v1/documents.

  1. Send the request.

Expected System Responses

JSON
{
  "name": "document_name",
  "type": "PROOF_OF_DELIVERY",
  "identifiers": [
    {
      "type": "BILL_OF_LADING",
      "value": "123456"
    },
    {
      "type": "CARRIER_SCAC",
      "value": "ABCD"
    }
  ],
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "files": [
    {
      "url": "string",
      "mediaType": "PDF",
      "sizeInBytes": 0,
      "type": "ORIGINAL"
    }
  ],
  "createdDateTime": "2024-08-24T14:15:22Z",
  "lastModifiedDateTime": "2024-08-24T14:15:22Z",
  "deletedDateTime": "2024-08-24T14:15:22Z",
  "addedByCompany": "string",
  "addedByUser": "string"
}

This is an example of what could be returned in the response. For the full request schema and descriptions for all fields and objects, please refer to the API documentation: POST /services/document/v1/documents.

Errors

If there was a problem with your request, you will receive one of the following error codes:

  • 400 Bad Request
  • 401 Unauthorized
  • 404 Not Found
Previous page