GET /api/v1/shipping_lines/:id
Returns information about a shipping line.

This API endpoint will return the information about a shipping line.

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/:id" -X GET -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Token token=YOUR TOKEN HERE"

{
   "shipping_line" : {
      "address" : "address",
      "carrier_type" : "ocean",
      "name" : "shipping line name",
      "id" : 22,
      "email" : "",
      "contact_person" : "",
      "phone" : "",
      "empty_container_storage_teu_quota" : null,
      "parent" : {
         "carrier_type" : "ocean",
         "synonyms" : [
            "CAT",
            "CLA"
         ],
         "name" : "parent shipping line",
         "id" : 20,
         "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"
      },
      "vat_number" : null,
      "receive_email_alerts_on_container_damages" : false,
      "synonyms" : [],
      "dock_receipt_email" : null,
      "general_ledger_id" : "SL22",
      "code" : "CODE"
   }
}

Params

Param name	Description
id required	You must pass the shipping line’s Octopi ID or shipping line’s code. Validations: Must be a String