Before you can use our API you need be a customer at IPAY Solutions Europe B.V. Please contact our sales department to access our services.

SetOrderShipped

POST

/Api/SetOrderShipped

Api

Last modified:2025-04-17 20:59:21

You can optional use this call to notify IPAY when an orders is fulfilled in a warehouse and the package is on its way to the consumer.
When IPAY has an integration with your shop platform, it will also set a note or a tag in the order in de shop (for instance in shopify we will set: Pending IPAY Payment)

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Carrier Id is the id of the carrier you get from IPAY API. For more info about IPAY transaction flow please visit: https://ipay.freshdesk.com/

transactionId

string | null

required

carrierId

integer <int32> | null

optional

trackAndTraceNumber

string | null

optional

trackAndTraceUrl

string | null

optional

Example

{
  "transactionId": "string",
  "carrierId": 0,
  "trackAndTraceNumber": "string",
  "trackAndTraceUrl": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.ipay-solutions.com/Api/SetOrderShipped' \
--header 'Content-Type: application/json' \
--data-raw '{
    "transactionId": "string",
    "carrierId": 0,
    "trackAndTraceNumber": "string",
    "trackAndTraceUrl": "string"
}'

Responses

🟢200OK

text/plain

Body

traceId

string <uuid>

read-onlyoptional

succeeded

boolean

read-onlyoptional

Flag indicating whether if the operation succeeded or not.

errors

array[object (ServiceError) {2}] | null

read-onlyoptional

An System.Collections.Generic.IEnumerable`1 of iPAY.Model.Common.ServiceErrors containing an errors
that occurred during the identity operation.

code

string | null

optional

description

string | null

optional

warnings

array[object (ServiceError) {2}] | null

read-onlyoptional

code

string | null

optional

description

string | null

optional

Example

{
  "traceId": "729bb1bf-882d-483b-89d3-5855dc5af3aa",
  "succeeded": true,
  "errors": [
    {
      "code": "string",
      "description": "string"
    }
  ],
  "warnings": [
    {
      "code": "string",
      "description": "string"
    }
  ]
}

Modified at 2025-04-17 20:59:21

GetTransactionStatus

GetCarriers