Order API - Capture Shipment
Capture shipment
Endpoint: PUT *base*/capture
Authentication: API Key
This will capture the payment for a shipment. You can use this on a shipment that has "shouldCapture": true
from Get shipments.
Parameters
The shipmentId
from Get shipments or Create shipment.
Response in xml format instead of json.
Request example
PUT <base>/capture HTTP/1.1
Content-type: application/json
{
"shipment": "83651-1"
}
Response
200
Content-type: application/json
ok
if success, else no
.
Order ID that was captured.
OShipment ID that was captured.
If status
returns no
, this value should send back a message why it failed.
Response example
{
"status": "ok",
"order": 83651,
"shipment": "83651-1"
}
Error example
{
"status": "no",
"msg": "capture failed",
"order": 83651,
"shipment": "83651-1"
}