Packing Instructions

Methods

Entity Properties

order_instruction.create 

order_instruction.create (string $orderUniqueId, string $note, object|null $options)

Create a new Packing Instruction.

Parameters

0 string
Order unique ID
1 string
Note
2 object|null
Additional Options (see “Packing Instruction”)

Return Value

An object with the new Packing Instruction. The “file_content” property is not returned. Use the order_instruction.list method to retrieve it.

Example Request

No file to print

{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "method" : "call",
    "params" : [
        "be1c13ed4e03f0ed7f1e4053dfff9658",
        "order_instruction.create",
        [
            "100000309",
            "Sign gift card with 'Happy Birthday, Susan!'",
            {
                "presentation" : "once_per_order"
            }
        ]
    ]
}

Upload a file using Base64 encoding

{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "method" : "call",
    "params" : [
        "be1c13ed4e03f0ed7f1e4053dfff9658",
        "order_instruction.create",
        [
            "100000309",
            "Place Amazon FBA Label in a pouch",
            {
                "file_name" : "amazon_fba_3425232.pdf",
                "file_content" : "base64-encoded file contents",
                "presentation" : "once_per_shipment",
                "print_target" : "LASER"
            }
        ]
    ]
}

Upload a file using an HTTP request

{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "method" : "call",
    "params" : [
        "be1c13ed4e03f0ed7f1e4053dfff9658",
        "order_instruction.create",
        [
            "100000309",
            "Place Amazon FBA Label in a pouch",
            {
                "file_name" : "amazon_fba_3425232.pdf",
                "file_request" : {
                    "url": "https://....",
                    "auth": ["username...","password..."],
                    "headers": {
                        "X-Custom-Header": "header value..."
                    }
                },
                "presentation" : "once_per_shipment",
                "print_target" : "LASER"
            }
        ]
    ]
}

Example Response

{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "error" : null,
    "result" : {
        "instruction_id" : 1,
        "order_id" : 118,
        "unique_id" : "100000309",
        "note" : "Place Amazon FBA Label in a pouch",
        "file_name" : "amazon_fba_3425232.pdf",
        "presentation" : "once_per_shipment",
        "print_target" : "LASER",
        "copies_printed" : "0",
        "confirmations" : []
    }
}

Error Codes

code message
100 Invalid data given. Details in error message.
102 Requested order does not exist.

order_instruction.edit 

order_instruction.edit (string $instructionId, string|null $note, object|null $options)

Modify the packing instruction.

Parameters

0 string|int
Instruction ID
1 string|null
Note
2 object|null
Additional Options (see “Packing Instruction”)

Return Value

An object with the updated Packing Instruction. The “file_content” property is not returned.

Example Request

{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "method" : "call",
    "params" : [
        "be1c13ed4e03f0ed7f1e4053dfff9658",
        "order_instruction.edit",
        [
            123,
            null,
            {
                "presentation" : "once_per_order"
            }
        ]
    ]
}

Example Response

{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "error" : null,
    "result" : {
        "instruction_id" : 1,
        "order_id" : 118,
        "unique_id" : "100000309",
        "note" : "Place Amazon FBA Label in a pouch",
        "file_name" : "amazon_fba_3425232.pdf",
        "presentation" : "once_per_order",
        "print_target" : "LASER",
        "copies_printed" : "0",
        "confirmations" : []
    }
}

Error Codes

code message
100 Invalid data given. Details in error message.
101 Requested packing instruction does not exist.

order_instruction.list 

order_instruction.list (string $orderUniqueId, array|null $fields = [])

Retrieve list of packing instructions.

Parameters

0 string
Order unique ID
1 array|null
Fields

Return Value

An array of objects. Each object will contain Packing Instruction properties. Include “file_content” to the list of the fields to return the “file_content” property.

Example Request

{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "method" : "call",
    "params" : [
        "be1c13ed4e03f0ed7f1e4053dfff9658",
        "order_instruction.list",
        [
            "100000309"
        ]
    ]
}

Example Response

{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "error" : null,
    "result" : [
        {
            "instruction_id" : 1,
            "order_id" : 118,
            "unique_id" : "100000309",
            "note" : "Place Amazon FBA Label in a pouch",
            "file_name" : "amazon_fba_3425232.pdf",
            "presentation" : "once_per_shipment",
            "print_target" : "LASER",
            "copies_printed" : "1",
            "confirmations" : [
                {
                    "confirmed_id" : "1",
                    "confirmed_at": "2022-02-08T14:59:38+00:00"
                }
            ]
        }
    ]
}

Error Codes

code message
100 Invalid data given. Details in error message.
102 Requested order does not exist.

order_instruction.delete 

order_instruction.delete (string $instructionId)

Delete packing instruction.

Parameters

0 string|int
Instruction ID

Return Value

true if the packing instruction was deleted.

Example Request

{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "method" : "call",
    "params" : [
        "be1c13ed4e03f0ed7f1e4053dfff9658",
        "order_instruction.delete",
        [
            123
        ]
    ]
}

Example Response

{
    "jsonrpc" : 2.0,
    "id" : 1234,
    "error" : null,
    "result" : true
}

Entity Properties

Packing Instruction Properties

note 
{ "note" : "Place Amazon FBA Label in a pouch" }
Instruction to the packer. The note is required.
file_name 
{ "file_name" : "amazon_fba_3425232.pdf" }
The name to be given to the file attached using the "file_content" or "file_request" properties.
file_content 
{ "file_content" : "base64-encoded file contents" }
The base64-encoded contents of the file. If specified you must also provide a "file_name".
file_request 
{ "file_request" : {
      "url": "https://....",
      "auth": ["username...","password..."],
      "headers": {
        "X-Custom-Header": "header value..."
      }
    } }
Attach a file using a url instead of file_content. The file will be downloaded using the optional auth and headers if specified. The file_name will be used if specified, but is optional and will otherwise be set using the Content-Disposition header value or the last part of the url.
presentation 
{ "presentation" : "once_per_shipment" }
The "presentation" property. Allowed values: "once_per_order", "once_per_shipment", "once_per_package".
print_target 
{ "print_target" : "LASER" }
The "print_target" property. Allowed values: "LABEL", "SMALL_LABEL", "LASER".
copies_printed 
{ "copies_printed" : "0" }
The "copies_printed" property.
confirmations 
{ "confirmations" : [] }
The instruction confirmations. See "Packing instruction Confirmation Properties".

Packing instruction Confirmation Properties

confirmed_id 
{ "confirmed_id" : "1" }
The ID of the instruction confirmation.
confirmed_at 
{ "confirmed_at" : "2022-02-08T14:59:38+00:00" }
Date and time when the instruction was confirmed in ISO 8601 format.