OrderItemList_CreateShipment

This function is used to create a shipment out of a list of line items in an order. Marking an order as shipped is a two step process. First you create a shipment with the items containted in the shipment, then you mark shipment as shipped using OrderShipmentList_Update

Request Body Parameters

order_id	Type: Number	Title: Order Id	Order Id containing line items
line_ids	Type: Array	Title: Line Ids	Array of Line Ids contained in the shipment. This is typically all line ids of the order but it is possible to create multiple shipments for an order. The line its are included in the OrderList_Load_Query response.

Response Parameters

success	Type: boolean	Title: Success	boolean value for if the request was successfull
id	Type: Number	Title: Id	shipment id of the created shipment. This will be passed into the OrderShipmentList_Update to mark the shipment as shipped.
code	Type: String	Title: Shipment Code	Shipment code generated by Miva
order_id	Type: Number	Title: Order ID	Order Id for items in shipment
status	Type: Number	Title: Shipment Status	Shipment Status. 100 = Picking, 200 = Shipped
labelcount	Type: Number	Title: Label Count	Number of Labels generated for this shipment (if labels were generated via Miva)
ship_date	Type: Unix Timestamp	Title: Ship Data	Unix timestamp of date shipped. 0 if not yet shipped
tracknum	Type: String	Title: Tracking Number	Tracking Number
tracktype	Type: String	Title: Tracking Type	Tracking Type. Default Types include "CanadaPost", "Endicia", "FedEx", "UPS", "USPS".
tracklink	Type: String	Title: Tracking Link	Full Tracking link to shipping carrier.
weight	Type: Number	Title: Shipment Weight	Total Shipment Weight
cost	Type: Number	Title: Shipment Cost	Tracking Cost.
formatted_cost	Type: String	Title: Formatted Cost	Formatted Cost
shipment_id	Type: Number	Title: Shipment ID	Same value as id. inlcuded for backwards compatibility.

Example Request

Example Response

Error Responses

error code MER-JSN-ORD-00025	error message Order not found	description Order id sent in request does not exist.
error code MER-JSN-ORD-0005	error message Order items must exist in order to create a shipment	description line_ids sent in request do not exist in the order sent