IBM API Connect Order API
The Order API from IBM API Connect — 1 operation(s) for order.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/ibm-api-connect:ibm-api-connect-order-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Order API
description: View and track your orders and deliveries.
termsOfService: https://github.com/ibm-apiconnect/sample-orders-api
contact:
name: IBM Corporation
url: https://www.ibm.com/products/api-connect
version: 2.0.0
x-ibm-name: ibm-sample-order-api
servers:
- url: /order
security:
- clientID: []
tags:
- name: Order
paths:
/{orderNumber}:
get:
summary: Retrieve the details of your order
parameters:
- name: orderNumber
in: path
description: Order number to lookup - you should find this in your confirmation e-mail
required: true
schema:
type: string
responses:
'200':
description: Order found successfully
content:
application/json:
schema:
title: Order Details
type: object
properties:
order_number:
title: Order Number
type: string
example: ORD00989792
tracking_status:
title: Tracking Status
type: object
properties: {}
shipped_at:
title: Date Shipped
type: string
format: date-time
created_at:
title: Date Order Created
type: string
format: date-time
status:
title: Order Status
type: string
enum:
- SHIPPED
- PICKED
- PENDING
- DELIVERED
tracking_reference:
title: Tracking Reference
type: string
tags:
- Order
operationId: getByOrderNumber
x-operation-id-source: derived
components:
securitySchemes:
clientID:
type: apiKey
name: X-IBM-Client-Id
in: header
externalDocs:
description: Github project for this API, containing source code and deployment pipeline
url: https://github.com/ibm-apiconnect/sample-orders-api
x-ibm-configuration:
properties:
target-url:
value: https://sample-api.us-east-a.apiconnect.automation.ibm.com/orders/order/{orderNumber}
description: URL of the proxy policy
encoded: false
cors:
enabled: true
gateway: datapower-api-gateway
type: rest
phase: realized
enforced: true
testable: true
assembly:
execute:
- invoke:
title: order lookup
version: 2.0.0
verb: keep
target-url: $(target-url)
follow-redirects: false
timeout: 60
parameter-control:
type: blocklist
values: []
header-control:
type: blocklist
values: []
inject-proxy-headers: true
persistent-connection: true
backend-type: json
output: order
description: Retrieves order data from the fulfillment system using the key of the provided order number.
- parse:
version: 2.1.0
title: parse response
parse-settings-reference:
default: apic-default-parsesettings
input: order
output: order
description: Parse the JSON from the order fulfillment system so that the values can be used later in the flow.
- map:
version: 2.0.0
title: map input to lambda
inputs:
input:
schema:
type: object
properties:
delivery_method:
type: string
name: delivery_method
tracking_reference:
type: string
name: tracking_reference
variable: order.body
outputs:
output:
schema:
type: object
properties:
shipper:
type: string
name: shipper
reference:
type: string
name: reference
variable: message.body
content: application/json
actions:
- set: output.shipper
from: input.delivery_method
- set: output.reference
from: input.tracking_reference
- invoke:
version: 2.2.0
title: 'lambda: track shipment'
backend-type: detect
header-control:
type: blocklist
values: []
parameter-control:
type: allowlist
values: []
http-version: HTTP/1.1
timeout: 60
verb: POST
chunked-uploads: true
persistent-connection: true
cache-response: protocol
cache-ttl: 900
stop-on-error: []
websocket-upgrade: false
target-url: https://plgej7e2skungmxzjakprvhe340qkrkl.lambda-url.us-east-1.on.aws/
output: tracking
graphql-send-type: detect
description: Call lambda function to look up the tracking for a parcel with the associated shipping company.
- map:
version: 2.0.0
title: combine data for response
inputs:
tracking:
schema:
type: object
properties:
trackResponse:
type: object
name: trackResponse
properties:
shipment:
type: object
name: shipment
properties:
package:
type: object
name: package
properties:
activity:
type: array
name: activity
items:
type: object
properties:
status:
type: object
name: status
variable: tracking.body
order:
schema:
type: object
properties:
order_number:
type: string
name: order_number
created_at:
type: string
name: created_at
shipped_at:
type: string
name: shipped_at
status:
type: string
name: status
tracking_reference:
type: string
name: tracking_reference
variable: order.body
outputs:
output:
schema:
type: object
properties:
order_number:
type: string
name: order_number
status:
type: string
name: status
shipped_at:
type: string
name: shipped_at
tracking_reference:
type: string
name: tracking_reference
tracking_status:
type: object
name: tracking_status
created_at:
type: string
name: created_at
variable: message.body
actions:
- set: output.order_number
from: order.order_number
- set: output.tracking_status
from: tracking.trackResponse.shipment.package.activity.status
- set: output.shipped_at
from: order.shipped_at
- set: output.tracking_reference
from: order.tracking_reference
- set: output.status
from: order.status
- set: output.created_at
from: order.created_at
finally: []
activity-log:
enabled: true
success-content: activity
error-content: payload
x-original-swagger-version: '2.0'