Configured system

shipping

Shipping Order Management mock. TMF700 v4 shipping order create, retrieve and patch.

shipping.tmfmock.com

Aliases shipping-order tmf700

Database-configured Runtime-routed Contract-shaped
System catalogue
Host shipping.tmfmock.com
Loaded from live configurationDB
3active endpoints
9bound paths
2configured aliases
DBlive configuration
Endpoint index

Endpoints on the wire

Loaded from the same database configuration used to dispatch mock requests.

MethodPrimary routeEndpointStatus
POST shipping.tmfmock.com/shippingOrder create-shipping-order 201
GET shipping.tmfmock.com/shippingOrder/:shippingOrderId retrieve-shipping-order 200
PATCH shipping.tmfmock.com/shippingOrder/:shippingOrderId update-shipping-order 200
Live configuration

Endpoints and bound rules

Every active method, path, request condition, and response formula currently bound to this system.

Endpoint 01

create-shipping-order

TMF700 v4 createShippingOrder. Acknowledges the delivery request and returns a schema-valid, tracking-ready shipping order.

Status
201
Priority
0
Paths
3

Bound paths

  • POST shipping.tmfmock.com/shippingOrder
  • POST shipping.tmfmock.com/tmf700/createShippingOrder
  • POST shipping.tmfmock.com/tmf-api/shippingOrder/v4/shippingOrder

Request conditions

Default

Every request matching a bound method and path uses this rule.

Bound response rule

JSON formula
{
  "body": {
    "id": {
      "$var": "shippingOrderId"
    },
    "href": {
      "$concat": [
        {
          "$request": "origin"
        },
        "/shippingOrder/",
        {
          "$var": "shippingOrderId"
        }
      ]
    },
    "@type": "ShippingOrder",
    "state": "acknowledged",
    "orderDate": "2026-08-30T00:00:00Z",
    "trackingCode": {
      "$var": "trackingCode"
    },
    "shippingOrderItem": [
      {
        "id": "1",
        "@type": "ShippingOrderItem",
        "state": "acknowledged",
        "action": "add",
        "product": {
          "id": {
            "$request": {
              "path": "body.shippingOrderItem.0.product.id",
              "default": "MOCK-SKU"
            }
          },
          "@type": "ProductRefOrValue"
        },
        "quantity": "1"
      },
      {
        "id": "2",
        "@type": "ShippingOrderItem",
        "state": "acknowledged",
        "action": "add",
        "product": {
          "id": "MOCK-SIM",
          "@type": "ProductRefOrValue"
        },
        "quantity": "1"
      }
    ],
    "shippingInstructions": {
      "$request": {
        "path": "body.shippingInstructions",
        "default": "Mock delivery"
      }
    }
  },
  "status": 201,
  "headers": {
    "Location": {
      "$concat": [
        {
          "$request": "origin"
        },
        "/shippingOrder/",
        {
          "$var": "shippingOrderId"
        }
      ]
    },
    "Content-Type": "application/json; charset=utf-8"
  },
  "variables": {
    "trackingCode": {
      "$random": "uuid"
    },
    "shippingOrderId": {
      "$request": {
        "path": "headers.idempotency-key",
        "default": {
          "$random": "uuid"
        }
      }
    }
  }
}

Endpoint 02

retrieve-shipping-order

TMF700 v4 retrieveShippingOrder. Returns the delivery request state for reconciliation.

Status
200
Priority
0
Paths
3

Bound paths

  • GET shipping.tmfmock.com/shippingOrder/:shippingOrderId
  • GET shipping.tmfmock.com/tmf700/retrieveShippingOrder/:shippingOrderId
  • GET shipping.tmfmock.com/tmf-api/shippingOrder/v4/shippingOrder/:shippingOrderId

Request conditions

Default

Every request matching a bound method and path uses this rule.

Bound response rule

JSON formula
{
  "body": {
    "id": {
      "$var": "shippingOrderId"
    },
    "href": {
      "$concat": [
        {
          "$request": "origin"
        },
        "/shippingOrder/",
        {
          "$var": "shippingOrderId"
        }
      ]
    },
    "@type": "ShippingOrder",
    "state": "inProgress",
    "orderDate": "2026-08-30T00:00:00Z",
    "trackingCode": {
      "$random": "uuid"
    },
    "shippingOrderItem": [
      {
        "id": "1",
        "@type": "ShippingOrderItem",
        "state": "inProgress",
        "action": "add",
        "product": {
          "id": "MOCK-SKU",
          "@type": "ProductRefOrValue"
        },
        "quantity": "1"
      }
    ],
    "expectedDeliveryDate": "2026-09-02T00:00:00Z",
    "shippingInstructions": "Mock delivery"
  },
  "status": 200,
  "headers": {
    "Content-Type": "application/json; charset=utf-8"
  },
  "variables": {
    "shippingOrderId": {
      "$request": {
        "path": "params.shippingOrderId",
        "default": "mock-shipping-order"
      }
    }
  }
}

Endpoint 03

update-shipping-order

TMF700 v4 patchShippingOrder. Returns the shipping order with state and instructions echoed from the request body.

Status
200
Priority
0
Paths
3

Bound paths

  • PATCH shipping.tmfmock.com/shippingOrder/:shippingOrderId
  • PATCH shipping.tmfmock.com/tmf700/patchShippingOrder/:shippingOrderId
  • PATCH shipping.tmfmock.com/tmf-api/shippingOrder/v4/shippingOrder/:shippingOrderId

Request conditions

Default

Every request matching a bound method and path uses this rule.

Bound response rule

JSON formula
{
  "body": {
    "id": {
      "$var": "shippingOrderId"
    },
    "href": {
      "$concat": [
        {
          "$request": "origin"
        },
        "/shippingOrder/",
        {
          "$var": "shippingOrderId"
        }
      ]
    },
    "@type": "ShippingOrder",
    "state": {
      "$var": "state"
    },
    "orderDate": "2026-08-30T00:00:00Z",
    "shippingOrderItem": [
      {
        "id": "1",
        "@type": "ShippingOrderItem",
        "state": {
          "$var": "state"
        },
        "action": "add",
        "product": {
          "id": "MOCK-SKU",
          "@type": "ProductRefOrValue"
        },
        "quantity": "1"
      }
    ],
    "shippingInstructions": {
      "$request": {
        "path": "body.shippingInstructions",
        "default": "Mock delivery"
      }
    }
  },
  "status": 200,
  "headers": {
    "Content-Type": "application/json; charset=utf-8"
  },
  "variables": {
    "state": {
      "$request": {
        "path": "body.state",
        "default": "inProgress"
      }
    },
    "shippingOrderId": {
      "$request": {
        "path": "params.shippingOrderId",
        "default": "mock-shipping-order"
      }
    }
  }
}
Incoming traffic

Requests and responses

Waiting for traffic

No requests captured yet.