Cross Border service OpenAPI specification (v2)

Download OpenAPI specification:Download

Fabric's Cross Border APIs provide high performance, multi-tenant service.

Service APIs

Request to re-validate orders

Request to re-validate orders that were on hold state at cross border

Request
header Parameters
required
object (SiteContext)

JSON object containing channel, account, stage, and date.

Authorization
required
string

Authorization token for the user

Example: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYxZjIyMTU4...
Request Body schema: application/json
orderNumbers
required
Array of strings

order numbers list to be re-validated

Responses
200

Ok

400

Client Error

404

Not Found

500

Internal Server Error

post/api/v2/order/cross-border/validate-order
Request samples
application/json
{
  • "orderNumbers": [
    ]
}
Response samples
application/json
{
  • "results": [
    ]
}

Request to release an order

Request to release an order that is on hold state at cross border

Request
header Parameters
required
object (SiteContext)

JSON object containing channel, account, stage, and date.

Authorization
required
string

Authorization token for the user

Example: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYxZjIyMTU4...
Request Body schema: application/json
orderNumber
required
string

order number to be released

releaseType
required
string

type of release for the order

Enum: "RELEASE" "CANCEL"
reasonCode
string

reason for release the order

subReasonCode
string

sub reason for release the order

note
string

general note for release the order

Responses
200

Ok

400

Client Error

404

Not Found

500

Internal Server Error

post/api/v2/order/cross-border/release-order
Request samples
application/json
{
  • "orderNumber": "string",
  • "releaseType": "RELEASE",
  • "reasonCode": "string",
  • "subReasonCode": "string",
  • "note": "string"
}
Response samples
application/json
{
  • "message": "Invalid request payload or parameter"
}

Events API

Request to release an order

Request to realese or validate orders that is on hold state at cross border

Request
header Parameters
required
object (SiteContext)

JSON object containing channel, account, stage, and date.

Authorization
required
string

Authorization token for the user

Example: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYxZjIyMTU4...
Request Body schema: application/json
version
string
id
string
detail-type
string
source
string
account
string
time
string <date-time>
region
string
ValidationOrderRequestedEvent (object) or ReleaseOrderRequestedEvent (object)
Responses
200

Ok

400

Client Error

404

Not Found

500

Internal Server Error

post/api/v2/event/cross-border-service
Request samples
application/json
{
  • "version": 1,
  • "id": "ca4f7be6-35a5-7630-6ddb-714555ad708e",
  • "detail-type": "ValidationOrderRequested or ReleaseOrderRequested",
  • "source": "order-service",
  • "account": "string",
  • "time": "2021-04-20T10:24:36.162Z",
  • "region": "us-east-1",
  • "detail": {
    }
}
Response samples
application/json
{
  • "message": "Invalid request payload or parameter"
}