Manifests
This resources allows you to create a manifest in Octopi.

Supported Formats

json
>>>

POST /api/v1/manifests.json
This API endpoint allows you to create a manifest

This API endpoint allows you to create a manifest. Please check the payload specification to make sure the required attributes are part of the payload and the optional attributes respect the specifications.

Supported Formats

json

Errors

Code Description
400 Bad Request
403 Forbidden
404 Not Found
422 Unprocessable Entity
500 Internal Server Error

Examples

curl "https://app.octopi.co/api/v1/manifests.json" -d '{ "voyage_id":"1234", "shipping_line":"Shipping Line Code" ,"manifest": {"client_identifier":"11223344"}}' -X POST -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Token token=ADD TOKEN HERE"

Example Payload:

{
  "voyage_id": 123,
  "shipping_line": "Shipping line Code",
  "manifest": {
    "client_identifier": "client_id",
    "remarks": "We build API for manifest"
  }
}

Params

Param name Description
shipping_line
required

This must be a shipping line code that exists in Octopi.

Validations:

  • Must be a String
voyage_id
optional

This must be a voyage ID that exists in Octopi. Either voyage id or voyage number is required.

Validations:

  • Must be a Integer
voyage_number
optional

This must be a voyage number that exists in Octopi. Either voyage id or voyage number is required.

Validations:

  • Must be a String
manifest
optional

Validations:

  • Must be a Hash
manifest[client_identifier]
required

Validations:

  • Must be a String
manifest[remarks]
optional

Validations:

  • Must be a String
manifest[sailing_date]
optional

Sailing date of the voyage in ISO 8601 format. For example, ‘2024-12-31’.

Validations:

  • Must be a String
manifest[shipping_line_voyage_number]
optional

Notice the shipping_line_voyage_number param is the number that will be used in the EDI messages sent to the shipping line. Make sure this is the Voyage Number your shipping line is expecting. voyage_number param will be used if left blank.

Validations:

  • Must be a String
>>>

DELETE /api/v1/manifests/:client_identifier
Deletes the manifest with the specified client identifier

This API endpoint allows you to delete a manifest by providing the client identifier of the manifest. Note that the manifest must be deletable for it to be deleted via the API. If the manifest cannot be deleted, an error message with the reason will be returned in the response.

Supported Formats

json

Errors

Code Description
400 Bad Request
403 Forbidden
404 Not Found
422 Unprocessable Entity
500 Internal Server Error

Examples

curl "https://app.octopi.co/api/v1/manifests/CLIENTIDENTIFIER123.json" -X DELETE -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Token token=ADD TOKEN HERE"

Params

Param name Description
client_identifier
required

The client identifier of the manifest to be deleted.

Validations:

  • Must be a String
>>>

GET /api/v1/manifests
Return a list of all the manifests

This API endpoint allows you to return a list of all the manifests in Octopi.

Supported Formats

json

Errors

Code Description
400 Bad Request
403 Forbidden
404 Not Found
422 Unprocessable Entity
500 Internal Server Error

Examples

curl "https://app.octopi.co/api/v1/manifests.json" -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Token token=ADD TOKEN HERE"

{
  "actions": {
    "next_page": {
      "method": "GET",
      "url": "https://app.octopi.co/api/v1/manifests.json?page=2&per=10"
    },
    "previous_page": {
      "method": "GET",
      "url": "https://app.octopi.co/api/v1/manifests.json?page=1&per=10"
    }
  },
  "manifests": [
    {
      "client_identifier": "TEST123",
      "voyage_number": "JUL162025",
      "shipping_line_voyage_number": null,
      "sailing_date": null,
      "shipping_line": {
        "code": "OCTO",
        "name": "OCTO Shipping Company",
        "synonyms": [],
        "carrier_type": "ocean",
        "agent": {
            "name": "OCTO Agent"
        }
      },
      "voyage": {
        "number": "JUL162025"
      },
      "arrival_date": "2025-07-21",
      "departure_date": null,
      "remarks": "Test manifest remarks"
    }
  ]
}

Params

Param name Description
voyage_number
optional

To filter manifest based on voyage number. This must be a voyage number that exists in Octopi.

Validations:

  • Must be a String