This API endpoint will return the information about all shipping lines.

Supported Formats

json

Errors

Code Description
400 Bad Request.
404 Resource Not Found.
500 Internal Server Error.

Examples

curl "https://app.octopi.co/api/v1/shipping_lines.json" -X GET -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Token token=YOUR TOKEN HERE" -d '{"name":"ship"}'
{
   "actions" : {
      "previous" : {
         "url" : "https://app.octopi.co/api/v1/shipping_lines?page=0",
         "method" : "GET"
      },
      "next" : {
         "url" : "https://app.octopi.co/api/v1/shipping_lines?page=2",
         "method" : "GET"
      },
      "last" : {
         "method" : "GET",
         "url" : "https://app.octopi.co/api/v1/shipping_lines?page=1"
      },
      "index" : {
         "url" : "https://app.octopi.co/api/v1/shipping_lines",
         "method" : "GET"
      }
   },
   "shipping_lines" : [
      {
         "receive_email_alerts_on_container_damages" : false,
         "synonyms" : [],
         "email" : "",
         "name" : "shipping line name",
         "code" : "CODE",
         "dock_receipt_email" : null,
         "contact_person" : "",
         "phone" : "",
         "vat_number" : null,
         "empty_container_storage_teu_quota" : null,
         "parent" : {
            "id" : 20,
            "carrier_type" : "ocean",
            "name" : "parent shipping line",
            "synonyms" : [
               "CAT"
            ],
            "code" : "PARENTCODE"
         },
         "edi_settings": {
            "id": 64,
            "edi_partner": {
                "id": 22,
                "name": "SEA",
                "edi_id": null
            },
            "name": null,
            "entity_edi_id": null,
            "communication_mode": "smtp",
            "time_zone": "timezone",
            "default_sender_id": "",
            "sender_edi_id": "",
            "edi_carrier_id": "",
            "edi_standard": "edifact"
         },
         "general_ledger_id" : "SL22",
         "id" : 22,
         "address" : "address",
         "carrier_type" : "ocean"
      }
   ]
}

Params

Param name Description
name
optional

Allows you to filter/search shipping lines by name or part of the name.

Validations:

  • Must be a String

code
optional

Allows you to filter/search shipping lines by full code.

Validations:

  • Must be a String

page
optional

Specify which page of results to fetch. This value defaults to 1.

Validations:

  • Must be a Integer

per
optional

The number of items to be displayed. This value defaults to 10 and accepts a maximum of 100.

Validations:

  • Must be a Integer