Create shipments

Transactions

Upload shipment information for a specific payment transaction. This endpoint allows merchants to provide tracking details for shipped orders, enabling better order tracking and customer communication.

POSThttps://api.efundpay.com/v4/transactions/<transaction_id>/shipments

This endpoint requires the shipments.write scope.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form `Bearer <token>`, where `<token>` is your auth token.

Headers

x-merchant-account-idstringrequired

The ID of the merchant account to use for this request.

Examples:"default"

idempotency-keystring

A unique key to ensure idempotency of the request. If provided, the same request will not be processed multiple times.

Examples:"unique-key-123"

Body

application/json

shipmentsarrayrequired

An array of shipment information.

Response

application/json

Successful Response

return_codestringrequired

The return code indicating the status of the request.

Examples:"SUCCESS""FAIL"

return_messagestringrequired

The return message providing additional information about the request status.

Examples:"Success""Invalid parameters"

trace_idstringrequired

The unique trace ID for tracking this request.

Examples:"7c510562b5af41a7a6d4f996f72f2dd0"

curl --request POST \
  --url https://api.efundpay.com/v4/transactions/<transaction_id>/shipments \
  --header 'Authorization: Bearer <token>' \
  --header 'x-merchant-account-id: <x-merchant-account-id>' \
  --header 'Content-Type: application/json' \
  --data '{
    "shipments": [
      {
        "carrier_code": "CJPacket YW Ordinary",
        "tracking_no": "UG3300003347YP",
        "country": "CN"
      }
    ]
  }'

{
  "return_code": "SUCCESS",
  "return_message": "Success",
  "trace_id": "7c510562b5af41a7a6d4f996f72f2dd0"
}