Create Shipment

POST {{baseUrl}}/shipments

This endpoint allows you to create a shipment related to your store directly from this endpoint.

Scope: shipping.read_write- Shipping Read & Write

Request Body

{"courier_id"=>"<integer>", "shipment_type"=>"return", "payment_method"=>"cod", "ship_to"=>{"name"=>"<string>", "email"=>"<string>", "phone"=>"<string>", "country_id"=>"<number>", "city_id"=>"<number>", "address_line"=>"<string>", "street_number"=>"<string>", "block"=>"<string>", "postal_code"=>"<string>", "geo_coordinates"=>{"lat"=>"<number>", "lng"=>"<string>"}}, "ship_from"=>{"type"=>"<string>", "branch_id"=>"<integer>", "name"=>"<string>", "email"=>"<string>", "phone"=>"<string>", "country"=>["<string>", "<string>"], "country_code"=>"<string>", "country_id"=>"<number>", "city"=>["<string>", "<string>"], "city_id"=>"<number>", "address_line"=>"<string>", "street_number"=>"<null>", "block"=>"<null>", "postal_code"=>"<null>", "geo_coordinates"=>{"latitude"=>["<string>", "<string>"], "longitude"=>["<string>", "<string>"]}}, "packages"=>[{"name"=>"<string>", "sku"=>"<string>", "price"=>{"amount"=>"<number>", "currency"=>"<string>"}, "quantity"=>"<integer>", "weight"=>{"value"=>"<integer>", "units"=>"lb"}}, {"name"=>"<string>", "sku"=>"<string>", "price"=>{"amount"=>"<number>", "currency"=>"<string>"}, "quantity"=>"<integer>", "weight"=>{"value"=>"<integer>", "units"=>"lb"}}], "order_id"=>"<integer>", "overwrite_exists_pending"=>"<boolean>", "policy_options"=>{"boxes"=>"<integer>"}, "cash_on_delivery"=>{"amount"=>"<number>", "currency"=>"<string>"}}

HEADERS

RESPONSES

status: OK

{"status":"\u003cnumber\u003e","success":"\u003cboolean\u003e","data":{"id":"\u003cnumber\u003e","order_id":"\u003cnumber\u003e","order_reference_id":"\u003cnumber\u003e","created_at":{"date":"\u003cstring\u003e","timezone_type":"\u003cinteger\u003e","timezone":"\u003cstring\u003e"},"type":"shipment","courier_id":"\u003cinteger\u003e","courier_name":"\u003cstring\u003e","courier_logo":"\u003cstring\u003e","shipping_number":"\u003cstring\u003e","tracking_number":"\u003cstring\u003e","pickup_id":"\u003cnumber\u003e","trackable":"\u003cboolean\u003e","tracking_link":"\u003cstring\u003e","label":{"format":"\u003cstring\u003e","url":"\u003cstring\u003e"},"payment_method":"cod","source":"\u003cstring\u003e","status":"creating","total":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"cash_on_delivery":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"is_international":"\u003cboolean\u003e","total_weight":{"value":"\u003cnumber\u003e","units":"\u003cstring\u003e"},"packages":[{"item_id":"\u003cinteger\u003e","external_id":"\u003cinteger\u003e","name":"\u003cstring\u003e","sku":"\u003cstring\u003e","price":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"quantity":"\u003cinteger\u003e","weight":{"value":"\u003cinteger\u003e","units":"lb"}},{"item_id":"\u003cinteger\u003e","external_id":"\u003cinteger\u003e","name":"\u003cstring\u003e","sku":"\u003cstring\u003e","price":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"quantity":"\u003cinteger\u003e","weight":{"value":"\u003cinteger\u003e","units":"g"}}],"ship_from":{"type":"\u003cstring\u003e","name":"\u003cstring\u003e","email":"\u003cstring\u003e","phone":"\u003cstring\u003e","country":"\u003cstring\u003e","city":"\u003cstring\u003e","address_line":"\u003cstring\u003e","street_number":"\u003cstring\u003e","block":"\u003cstring\u003e","postal_code":"\u003cstring\u003e","latitude":"\u003cnumber\u003e","longitude":"\u003cnumber\u003e","branch_id":"\u003cinteger\u003e"},"ship_to":{"type":"\u003cstring\u003e","name":"\u003cstring\u003e","email":"\u003cstring\u003e","phone":"\u003cstring\u003e","country":"\u003cstring\u003e","city":"\u003cstring\u003e","address_line":"\u003cstring\u003e","street_number":"\u003cstring\u003e","block":"\u003cstring\u003e","postal_code":"\u003cstring\u003e","latitude":"\u003cnumber\u003e","longitude":"\u003cnumber\u003e"},"meta":{"app_id":"\u003cinteger\u003e","policy_options":{"shipment_content_type":["dry","food_stuff"],"packaging_type":["box","pallet"],"boxes":"\u003cinteger\u003e"}}}}