Shipstation v0.3.5 Shipstation.Order
Manage orders on your account.
Summary
Functions
Adds a tag to an order
Assigns a user to an order
Creates a shipping label for a given order
Removes order from ShipStation’s UI. Note this is a “soft” delete action so
the order will still exist in the database, but will be set to inactive
Retrieves a single order from the database
This method will change the status of the given order to On Hold until the date specified, when the status will automatically change to Awaiting Shipment
List orders without parameters
List orders with filter parameters
List orders that match the specified status and tag ID
Marks an order as shipped without creating a label in ShipStation
Removes a tag from an order
This method will change the status of the given order from On Hold to Awaiting
Shipment. This endpoint is used when a holdUntil
Date is attached to an order
Unassigns a user from an order
This endpoint can be used to create or update multiple orders in one request. If the orderKey is specified in an order, the existing order with that key will be updated
Functions
add_tag(order_id :: integer, tag_id :: integer) :: Shipstation.Client.response_type
Adds a tag to an order
assign_user(order_id :: integer, user_id :: integer) :: Shipstation.Client.response_type
assign_user(order_ids :: [integer], user_id :: integer) :: Shipstation.Client.response_type
Assigns a user to an order
create_label(order :: Shipstation.Structs.Label.t) :: Shipstation.Client.response_type
Creates a shipping label for a given order.
The labelData
field returned in the response is a base64 encoded PDF value.
Simply decode and save the output as a PDF file to retrieve a printable label.
Removes order from ShipStation’s UI. Note this is a “soft” delete action so
the order will still exist in the database, but will be set to inactive
Retrieves a single order from the database.
hold_until(order_id :: integer, hold_until_date :: String.t) :: Shipstation.Client.response_type
This method will change the status of the given order to On Hold until the date specified, when the status will automatically change to Awaiting Shipment.
List orders without parameters
list(order_filter :: Shipstation.Structs.OrderFilter.t) :: Shipstation.Client.response_type
List orders with filter parameters
list_by_tag(order_status :: String.t, tag_id :: integer, page :: non_neg_integer, page_size :: non_neg_integer) :: Shipstation.Client.response_type
List orders that match the specified status and tag ID.
mark_as_shipped(params :: Shipstation.Structs.OrderShipped.t) :: Shipstation.Client.response_type
Marks an order as shipped without creating a label in ShipStation.
remove_tag(order_id :: integer, tag_id :: integer) :: Shipstation.Client.response_type
Removes a tag from an order
restore_from_on_hold(order_id :: integer) :: Shipstation.Client.response_type
This method will change the status of the given order from On Hold to Awaiting
Shipment. This endpoint is used when a holdUntil
Date is attached to an order.
unassign_user(order_id :: integer) :: Shipstation.Client.response_type
unassign_user(order_ids :: [integer]) :: Shipstation.Client.response_type
Unassigns a user from an order.
upsert(order :: Shipstation.Structs.Order.t) :: Shipstation.Client.response_type
upsert(orders :: [Shipstation.Structs.Order.t]) :: Shipstation.Client.response_type
This endpoint can be used to create or update multiple orders in one request. If the orderKey is specified in an order, the existing order with that key will be updated.
Note: Only orders in an open status in ShipStation (awaiting_payment
,
awaiting_shipment
, and on_hold
) can be updated through this method.
cancelled and shipped are locked from modification through the API.