Documentation Index Fetch the complete documentation index at: https://docs.shipstream.io/llms.txt
Use this file to discover all available pages before exploring further.
Methods Entity Properties order_instruction.createorder_instruction.create (string $orderUniqueId, string $note, object|null $options)Create a new Packing Instruction.
Parameters 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.editorder_instruction.edit (string $instructionId, string|null $note, object|null $options)Modify the packing instruction.
Parameters 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.listorder_instruction.list (string $orderUniqueId, array|null $fields = [])Retrieve list of packing instructions.
Parameters 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.deleteorder_instruction.delete (string $instructionId)Delete packing instruction.
Parameters 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 Show Packing Instruction Properties
Instruction to the packer. The note is required.
The name to be given to the file attached using the “file_content” or “file_request” properties.
The base64-encoded contents of the file. If specified you must also provide a “file_name”.
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.
The “presentation” property. Allowed values: “once_per_order”, “once_per_shipment”, “once_per_package”.
The “print_target” property. Allowed values: “LABEL”, “SMALL_LABEL”, “LASER”.
The “copies_printed” property.
Packing instruction Confirmation Properties Show Packing instruction Confirmation Properties
The ID of the instruction confirmation.
Date and time when the instruction was confirmed in ISO 8601 format.
