Add shipping information

Add shipping information to previously captured transaction

SecurityBearer Authentication
Request
path Parameters
ratepay_transaction_id
required
string

ID of transaction. Get an overview of key identifiers used in payment API.

ratepay_capture_id
required
string

ID of capture the shipping information should be added to. Get an overview of key identifiers used in payment API.

header Parameters
Idempotency-Key
string <= 64 characters

ID generated by client to uniquely identify the request. It is highly recommended to use a UUID version 4. Do not reuse an idempotency key for different calls. See Idempotency for further details.

Prefer
string

According to RFC 7240: Provide return=representation if you prefer that the response to a request includes the current state of the resource.

Value: "return=representation"
Request Body schema: application/json
required
carrier_name
required
string

Name of carrier responsible for shipment.

Enum: "DHL" "POST_AUSTRIA" "UPS" "DPD" "SWISS_POST" "GLS" "ASENDIA" "HERMES_LOGISTICS" "FEDEX" "OTHER_WITH_TRACKING" "OTHER_WITHOUT_TRACKING"
tracking_number
string [ 1 .. 127 ] characters

Tracking number for delivery. This field is mandatory for each carrier_name except: OTHER_WITHOUT_TRACKING

Responses
201

Shipping information added

400

Bad request

404

Transaction or capture not found

451

Legally not allowed

500

Technical problem

post/v2/transactions/{ratepay_transaction_id}/captures/{ratepay_capture_id}/shipping-information
Request samples
application/json
{
  • "carrier_name": "DHL",
  • "tracking_number": "tracking-123456789"
}
Response samples
application/hal+json
{}