Supported Formats

json

GET /api/v1/bill_of_ladings/:bill_of_lading_number/packing_lists.json

Supported Formats

json

Errors

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

Examples

curl "https://app.octopi.co/api/v1/bill_of_ladings/:bill_of_lading_number/packing_lists.json" -X GET -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Token token=ADD TOKEN HERE"
Example Payload:

{
  "actions" : {
    "create" : {
      "method" : "POST",
      "url" : "http://app.octopi.co/api/v1/bill_of_ladings/ZIMUPAN2018926/packing_lists"
    },
    "index" : {
      "method" : "GET",
      "url" : "http://app.octopi.co/api/v1/bill_of_ladings/ZIMUPAN2018926/packing_lists"
    }
  },
  "packing_lists" : [
    {
      "items_count" : 2,
      "bill_of_lading" : {
        "number" : "ZIMUPAN2018926",
        "id" : 232224
      },
      "created_at" : "2018-04-18T12:31:52.304Z",
      "updated_at" : "2018-04-18T12:31:52.304Z",
      "client_identifier" : "9b47fc8b-e885-460f-95c0-fc346064a9f4",
      "container" : {
        "number" : "TCNU9818966",
        "id" : 914126
      },
      "id" : 59728
    },
    {
      "client_identifier" : "d2866ad7-f429-40e6-ac61-eca7b23da139",
      "updated_at" : "2018-04-18T12:48:19.668Z",
      "id" : 59735,
      "container" : {
        "number" : "TCNU9818966",
        "id" : 914126
      },
      "items_count" : 2,
      "bill_of_lading" : {
        "number" : "ZIMUPAN2018926",
        "id" : 232224
      },
      "created_at" : "2018-04-18T12:48:19.668Z"
    }
  ]
}

POST /api/v1/bill_of_ladings/:bill_of_lading_number/packing_lists.json

Supported Formats

json

Errors

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

Examples

curl "https://app.octopi.co/api/v1/bill_of_ladings/:bill_of_lading_number/packing_lists.json" -d '{ "container_number": "CONTNUMBER", packing_list: { "client_identifier": "identifier" }}' -X POST -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Token token=ADD TOKEN HERE"
Example Payload:
{
  "container_number": "CONTNUMBER",
  "packing_list": {
    "client_identifier": "ABC12312"
  }
}

Params

Param name Description
bill_of_lading_number
required

Validations:

  • Must be a String

container_number
optional

Validations:

  • Must be a String

client_identifier
optional

Validations:

  • Must be a String

packing_list
required

Validations:

  • Must be a Hash


DELETE /api/v1/bill_of_ladings/:bill_of_lading_number/packing_lists/:client_identifier.json

Supported Formats

json

Errors

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