Update Order Shipment

PUT {{baseUrl}}/orders/:order_id/update-shipment

You can update specific Order Shipment Details (tracking link, shipment number, pdf label and shipment type) by providing the ID of the order you want to update its details in the order.id path parameter.

Request Body

{"shipment_number"=>"<string>", "tracking_link"=>"<string>", "pdf_label"=>"<string>", "shipment_type"=>"shipment", "cost"=>"<number>"}

HEADERS

RESPONSES

status: Created

{"status":"\u003cnumber\u003e","success":"\u003cboolean\u003e","data":{"id":"\u003cinteger\u003e","reference_id":"\u003cinteger\u003e","urls":{"customer":"\u003cstring\u003e","admin":"\u003cstring\u003e"},"date":{"date":"\u003cdateTime\u003e","timezone_type":"\u003cnumber\u003e","timezone":"\u003cstring\u003e"},"source":"\u003cstring\u003e","source_device":"\u003cstring\u003e","source_details":{"type":"\u003cstring\u003e","value":"\u003cstring\u003e","device":"\u003cstring\u003e","user-agent":"\u003cstring\u003e","ip":"\u003cstring\u003e"},"first_complete_at":{"date":"\u003cstring\u003e","timeone_type":"\u003cinteger\u003e","timezone":"\u003cstring\u003e"},"status":{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e","slug":"\u003cstring\u003e"},"payment_method":"\u003cstring\u003e","currency":"\u003cstring\u003e","amounts":{"sub_total":{"amount":"\u003cinteger\u003e","currency":"\u003cstring\u003e"},"shipping_cost":{"amount":"\u003cinteger\u003e","currency":"\u003cstring\u003e"},"cash_on_delivery":{"amount":"\u003cinteger\u003e","currency":"\u003cstring\u003e"},"tax":{"percent":"\u003cstring\u003e","amount":{"amount":"\u003cinteger\u003e","currency":"\u003cstring\u003e"}},"discounts":[{"title":"\u003cstring\u003e","type":"\u003cstring\u003e","code":"\u003cstring\u003e","discount":"\u003cstring\u003e","discounted_shipping":"\u003cinteger\u003e"},{"title":"\u003cstring\u003e","type":"\u003cstring\u003e","code":"\u003cstring\u003e","discount":"\u003cstring\u003e","discounted_shipping":"\u003cinteger\u003e"}],"total":{"amount":"\u003cinteger\u003e","currency":"\u003cstring\u003e"}},"shipping":{"id":"\u003cinteger\u003e","app_id":"\u003cstring\u003e","company":"\u003cstring\u003e","logo":"\u003cstring\u003e","receiver":{"name":"\u003cstring\u003e","email":"\u003cstring\u003e","phone":"\u003cstring\u003e"},"shipper":{"name":"\u003cstring\u003e","company_name":"\u003cstring\u003e","email":"\u003cstring\u003e","phone":"\u003cstring\u003e"},"pickup_address":{"country":"\u003cstring\u003e","country_code":"\u003cstring\u003e","city":"\u003cstring\u003e","shipping_address":"\u003cstring\u003e","street_number":"\u003cstring\u003e","block":"\u003cstring\u003e","postal_code":"\u003cstring\u003e","geo_coordinates":{"lat":"\u003cnumber\u003e","lng":"\u003cnumber\u003e"}},"address":{"country":"\u003cstring\u003e","country_code":"\u003cstring\u003e","city":"\u003cstring\u003e","shipping_address":"\u003cstring\u003e","street_number":"\u003cstring\u003e","block":"\u003cstring\u003e","postal_code":"\u003cstring\u003e","geo_coordinates":{"lat":"\u003cinteger\u003e","lng":"\u003cinteger\u003e"}},"shipment":{"id":"\u003cstring\u003e","pickup_id":"\u003cinteger\u003e","tracking_link":"\u003cstring\u003e","label":[{"format":"\u003cstring\u003e","url":"\u003cstring\u003e"},{"format":"\u003cstring\u003e","url":"\u003cstring\u003e"}]},"policy_options":[{"boxes":"\u003cstring\u003e"},{"boxes":"\u003cstring\u003e"}]},"shipments":[{"id":"\u003cstring\u003e","created_at":"\u003cstring\u003e","type":"\u003cstring\u003e","courier_id":"\u003cnumber\u003e","courier_name":"\u003cstring\u003e","courier_logo":"\u003cstring\u003e","shipping_number":"\u003cstring\u003e","tracking_number":"\u003cstring\u003e","pickup_id":"\u003cinteger\u003e","trackable":true,"tracking_link":"\u003cstring\u003e","label":{"format":"\u003cstring\u003e","url":"\u003cstring\u003e"},"payment_method":"\u003cstring\u003e","source":"\u003cstring\u003e","total":{"amount":"\u003cstring\u003e","currency":"\u003cstring\u003e"},"cash_on_delivery":{"amount":"\u003cstring\u003e","currency":"\u003cstring\u003e"},"ship_to":{"type":"\u003cstring\u003e","name":"\u003cstring\u003e","email":"\u003cstring\u003e","phone":"\u003cstring\u003e","country":"\u003cstring\u003e","country_code":"\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"},"ship_from":{"type":"\u003cstring\u003e","name":"\u003cstring\u003e","company_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"},"total_weight":{"value":"\u003cnumber\u003e","units":"\u003cstring\u003e"},"packages":"\u003carray\u003e","is_international":false,"meta":{"app_id":"\u003cstring\u003e","policy_options":{"boxes":"\u003cstring\u003e"}}},{"id":"\u003cstring\u003e","created_at":"\u003cstring\u003e","type":"\u003cstring\u003e","courier_id":"\u003cnumber\u003e","courier_name":"\u003cstring\u003e","courier_logo":"\u003cstring\u003e","shipping_number":"\u003cstring\u003e","tracking_number":"\u003cstring\u003e","pickup_id":"\u003cinteger\u003e","trackable":true,"tracking_link":"\u003cstring\u003e","label":{"format":"\u003cstring\u003e","url":"\u003cstring\u003e"},"payment_method":"\u003cstring\u003e","source":"\u003cstring\u003e","total":{"amount":"\u003cstring\u003e","currency":"\u003cstring\u003e"},"cash_on_delivery":{"amount":"\u003cstring\u003e","currency":"\u003cstring\u003e"},"ship_to":{"type":"\u003cstring\u003e","name":"\u003cstring\u003e","email":"\u003cstring\u003e","phone":"\u003cstring\u003e","country":"\u003cstring\u003e","country_code":"\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"},"ship_from":{"type":"\u003cstring\u003e","name":"\u003cstring\u003e","company_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"},"total_weight":{"value":"\u003cnumber\u003e","units":"\u003cstring\u003e"},"packages":"\u003carray\u003e","is_international":false,"meta":{"app_id":"\u003cstring\u003e","policy_options":{"boxes":"\u003cstring\u003e"}}}],"can_cancel":"\u003cboolean\u003e","show_weight":"\u003cboolean\u003e","can_reorder":"\u003cboolean\u003e","is_pending_payment":"\u003cboolean\u003e","pending_payment_ends_at":"\u003cinteger\u003e","total_weight":"\u003cstring\u003e","rating_link":"\u003cstring\u003e","shipment_branch":{"id":"\u003cnumber\u003e","name":"\u003cstring\u003e","status":"\u003cstring\u003e","is_default":"\u003cboolean\u003e","type":"\u003cstring\u003e"},"customer":{"id":"\u003cnumber\u003e","first_name":"\u003cstring\u003e","last_name":"\u003cstring\u003e","mobile":"\u003cnumber\u003e","mobile_code":"\u003cstring\u003e","email":"\u003cstring\u003e","urls":{"customer":"\u003cstring\u003e","admin":"\u003cstring\u003e"},"avatar":"\u003cstring\u003e","gender":"\u003cstring\u003e","brithday":{"date":"\u003cstring\u003e","timezone_type":"\u003cinteger\u003e","timezone":"\u003cstring\u003e"},"city":"\u003cstring\u003e","country":"\u003cstring\u003e","country_code":"\u003cstring\u003e","currency":"\u003cstring\u003e","location":"\u003cstring\u003e","updated_at":{"date":"\u003cdateTime\u003e","timezone_type":"\u003cnumber\u003e","timezone":"\u003cstring\u003e"}},"items":[{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e","sku":"\u003cstring\u003e","quantity":"\u003cinteger\u003e","currency":"\u003cstring\u003e","weight":"\u003cnumber\u003e","weight_label":"\u003cstring\u003e","amounts":{"price_without_tax":{"amount":"\u003cinteger\u003e","currency":"\u003cstring\u003e"},"total_discount":{"amount":"\u003cinteger\u003e","currency":"\u003cstring\u003e"},"tax":{"percent":"\u003cstring\u003e","amount":{"amount":"\u003cinteger\u003e","currency":"\u003cstring\u003e"}},"total":{"amount":"\u003cinteger\u003e","currency":"\u003cstring\u003e"}},"notes":"\u003cstring\u003e","product":{"id":"\u003cnumber\u003e","type":"codes","promotion":{"title":"\u003cstring\u003e","sub_title":"\u003cstring\u003e"},"status":"\u003cstring\u003e","is_available":"\u003cboolean\u003e","sku":"\u003cstring\u003e","name":"\u003cstring\u003e","price":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"sale_price":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"url":"\u003cstring\u003e","has_special_price":"\u003cboolean\u003e","regular_price":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"currency":"\u003cstring\u003e","thumbnail":"\u003cstring\u003e","calories":"\u003cstring\u003e","mpn":"\u003cstring\u003e","gtin":"\u003cstring\u003e","favorite":"\u003cstring\u003e","starting_price":"\u003cstring\u003e"},"options":[{"id":"\u003cinteger\u003e","product_option_id":"\u003cinteger\u003e","name":"\u003cstring\u003e","type":"image","value":"\u003carray,string\u003e"},{"id":"\u003cinteger\u003e","product_option_id":"\u003cinteger\u003e","name":"\u003cstring\u003e","type":"splitter","value":"\u003carray,string\u003e"}],"images":[{"id":"\u003cinteger\u003e","image":"\u003cstring\u003e","type":"\u003cstring\u003e"},{"id":"\u003cinteger\u003e","image":"\u003cstring\u003e","type":"\u003cstring\u003e"}],"codes":[{"code":"\u003cstring\u003e","status":"\u003cstring\u003e"},{"code":"\u003cstring\u003e","status":"\u003cstring\u003e"}],"files":[{"url":"\u003cstring\u003e","name":"\u003cstring\u003e","size":"\u003cnumber\u003e"},{"url":"\u003cstring\u003e","name":"\u003cstring\u003e","size":"\u003cnumber\u003e"}]},{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e","sku":"\u003cstring\u003e","quantity":"\u003cinteger\u003e","currency":"\u003cstring\u003e","weight":"\u003cnumber\u003e","weight_label":"\u003cstring\u003e","amounts":{"price_without_tax":{"amount":"\u003cinteger\u003e","currency":"\u003cstring\u003e"},"total_discount":{"amount":"\u003cinteger\u003e","currency":"\u003cstring\u003e"},"tax":{"percent":"\u003cstring\u003e","amount":{"amount":"\u003cinteger\u003e","currency":"\u003cstring\u003e"}},"total":{"amount":"\u003cinteger\u003e","currency":"\u003cstring\u003e"}},"notes":"\u003cstring\u003e","product":{"id":"\u003cnumber\u003e","type":"codes","promotion":{"title":"\u003cstring\u003e","sub_title":"\u003cstring\u003e"},"status":"\u003cstring\u003e","is_available":"\u003cboolean\u003e","sku":"\u003cstring\u003e","name":"\u003cstring\u003e","price":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"sale_price":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"url":"\u003cstring\u003e","has_special_price":"\u003cboolean\u003e","regular_price":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"currency":"\u003cstring\u003e","thumbnail":"\u003cstring\u003e","calories":"\u003cstring\u003e","mpn":"\u003cstring\u003e","gtin":"\u003cstring\u003e","favorite":"\u003cstring\u003e","starting_price":"\u003cstring\u003e"},"options":[{"id":"\u003cinteger\u003e","product_option_id":"\u003cinteger\u003e","name":"\u003cstring\u003e","type":"splitter","value":"\u003carray,string\u003e"},{"id":"\u003cinteger\u003e","product_option_id":"\u003cinteger\u003e","name":"\u003cstring\u003e","type":"datetime","value":"\u003carray,string\u003e"}],"images":[{"id":"\u003cinteger\u003e","image":"\u003cstring\u003e","type":"\u003cstring\u003e"},{"id":"\u003cinteger\u003e","image":"\u003cstring\u003e","type":"\u003cstring\u003e"}],"codes":[{"code":"\u003cstring\u003e","status":"\u003cstring\u003e"},{"code":"\u003cstring\u003e","status":"\u003cstring\u003e"}],"files":[{"url":"\u003cstring\u003e","name":"\u003cstring\u003e","size":"\u003cnumber\u003e"},{"url":"\u003cstring\u003e","name":"\u003cstring\u003e","size":"\u003cnumber\u003e"}]}],"bank":{"id":"\u003cinteger\u003e","bank_name":"\u003cstring\u003e","bank_id":"\u003cinteger\u003e","account_name":"\u003cstring\u003e","account_number":"\u003cstring\u003e","iban_number":"\u003cstring\u003e","status":"\u003cstring\u003e"},"tags":{"id":"\u003cnumber\u003e","name":"\u003cstring\u003e"},"pickup_branch":{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e","status":"inactive","location":{"lat":"\u003cstring\u003e","lng":"\u003cstring\u003e"},"street":"\u003cstring\u003e","address_description":"\u003cstring\u003e","additional_number":"\u003cstring\u003e","building_number":"\u003cstring\u003e","local":"\u003cstring\u003e","postal_code":"\u003cstring\u003e","contacts":{"phone":"\u003cstring\u003e","whatsapp":"\u003cstring\u003e","telephone":"\u003cstring\u003e"},"preparation_time":"\u003cstring\u003e","is_open":"\u003cboolean\u003e","closest_time":{"description":"The time when the branch will be closed based on the request time. Each request may have a different value. ","nullable":true},"working_hours":[{"name":"\u003cstring\u003e","times":[{"from":"\u003cstring\u003e","to":"\u003cstring\u003e"},{"from":"\u003cstring\u003e","to":"\u003cstring\u003e"}]},{"name":"\u003cstring\u003e","times":[{"from":"\u003cstring\u003e","to":"\u003cstring\u003e"},{"from":"\u003cstring\u003e","to":"\u003cstring\u003e"}]}],"is_cod_available":"\u003cboolean\u003e","is_default":"\u003cboolean\u003e","type":"warehouse","cod_cost":"\u003cstring\u003e","country":{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e","name_en":"\u003cstring\u003e","code":"\u003cstring\u003e","mobile_code":"\u003cstring\u003e"},"city":{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e","name_en":"\u003cstring\u003e"}}}}