Service live

Configured system

order-management

TMF622 Product Ordering Management mock endpoints

order-management.tmfmock.com

Aliases order_management order om

Explore endpoints ↗ View rule metadata
Database-configured Runtime-routed Contract-shaped
System catalogue
Host order-management.tmfmock.com
01 list-product-orders GET 02 create-product-order POST 03 retrieve-product-order GET 04 patch-product-order PATCH 05 delete-product-order DELETE 06 list-cancel-product-orders GET 07 create-cancel-product-order POST 08 retrieve-cancel-product-order GET 09 register-order-event-listener POST 10 unregister-order-event-listener DELETE
Loaded from live configurationDB
10active endpoints
22bound paths
3configured aliases
DBlive configuration
Endpoint index

Endpoints on the wire

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

MethodPrimary routeEndpointStatus
GET order-management.tmfmock.com/tmf622/productOrder list-product-orders 200
POST order-management.tmfmock.com/productOrder create-product-order 201
GET order-management.tmfmock.com/tmf622/productOrder/:id retrieve-product-order 200
PATCH order-management.tmfmock.com/tmf622/productOrder/:id patch-product-order 200
DELETE order-management.tmfmock.com/tmf622/productOrder/:id delete-product-order 204
GET order-management.tmfmock.com/tmf622/cancelProductOrder list-cancel-product-orders 200
POST order-management.tmfmock.com/tmf622/cancelProductOrder create-cancel-product-order 201
GET order-management.tmfmock.com/tmf622/cancelProductOrder/:id retrieve-cancel-product-order 200
POST order-management.tmfmock.com/tmf622/hub register-order-event-listener 201
DELETE order-management.tmfmock.com/tmf622/hub/:id unregister-order-event-listener 204
Live configuration

Endpoints and bound rules

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

Endpoint 01

list-product-orders

Lists TMF622 ProductOrder resources with bounded mock pagination.

Status
200
Priority
0
Paths
2

Bound paths

  • GET order-management.tmfmock.com/tmf622/productOrder
  • GET order-management.tmfmock.com/tmf-api/productOrderingManagement/v4/productOrder

Request conditions

Default

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

Bound response rule

JSON formula 
{
  "body": {
    "$repeat": {
      "max": 100,
      "min": 1,
      "count": {
        "$var": "count"
      },
      "template": {
        "id": {
          "$concat": [
            "PO-",
            {
              "$var": "number"
            }
          ]
        },
        "href": {
          "$concat": [
            {
              "$request": "origin"
            },
            "/tmf-api/productOrderingManagement/v4/productOrder/PO-",
            {
              "$var": "number"
            }
          ]
        },
        "@type": "ProductOrder",
        "state": "acknowledged",
        "category": "consumer",
        "priority": "3",
        "orderDate": "2026-08-31T00:00:00.000Z",
        "externalId": {
          "$concat": [
            "CRM-",
            {
              "$var": "number"
            }
          ]
        },
        "description": "Mock product order",
        "relatedParty": [
          {
            "id": "customer-001",
            "name": "Mock customer",
            "role": "customer",
            "@type": "RelatedParty",
            "@referredType": "Individual"
          }
        ],
        "billingAccount": {
          "id": "BA-001",
          "href": {
            "$concat": [
              {
                "$request": "origin"
              },
              "/tmf-api/accountManagement/v4/billingAccount/BA-001"
            ]
          },
          "name": "Mock billing account",
          "@referredType": "BillingAccount"
        },
        "productOrderItem": [
          {
            "id": "1",
            "@type": "ProductOrderItem",
            "state": "acknowledged",
            "action": "add",
            "quantity": 1,
            "productOffering": {
              "id": "offer-mobile-basic",
              "name": "Mobile Basic",
              "@referredType": "ProductOffering"
            }
          }
        ],
        "requestedStartDate": "2026-09-01T09:00:00.000Z",
        "expectedCompletionDate": "2026-09-05T17:00:00.000Z",
        "requestedCompletionDate": "2026-09-05T17:00:00.000Z"
      }
    }
  },
  "status": 200,
  "headers": {
    "Content-Type": "application/json; charset=utf-8",
    "X-Total-Count": {
      "$var": "count"
    },
    "X-Result-Count": {
      "$var": "count"
    }
  },
  "variables": {
    "count": {
      "$request": {
        "max": 100,
        "min": 1,
        "path": "query.limit",
        "type": "integer",
        "default": 2
      }
    }
  }
}

Endpoint 02

create-product-order

TMF622 createProductOrder. Creates a ProductOrder with a stable idempotency ID or a generated UUID.

Status
201
Priority
0
Paths
4

Bound paths

  • POST order-management.tmfmock.com/productOrder
  • POST order-management.tmfmock.com/tmf622/createProductOrder
  • POST order-management.tmfmock.com/tmf622/productOrder
  • POST order-management.tmfmock.com/tmf-api/productOrderingManagement/v4/productOrder

Request conditions

Default

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

Bound response rule

JSON formula 
{
  "body": {
    "id": {
      "$var": "orderId"
    },
    "href": {
      "$concat": [
        {
          "$request": "origin"
        },
        "/tmf-api/productOrderingManagement/v4/productOrder/",
        {
          "$var": "orderId"
        }
      ]
    },
    "@type": "ProductOrder",
    "state": "acknowledged",
    "category": {
      "$request": {
        "path": "body.category",
        "default": "consumer"
      }
    },
    "priority": {
      "$request": {
        "path": "body.priority",
        "default": "3"
      }
    },
    "orderDate": "2026-08-31T00:00:00.000Z",
    "externalId": {
      "$request": {
        "path": "body.externalId",
        "default": {
          "$random": {
            "type": "digits",
            "length": 8,
            "prefix": "CRM-"
          }
        }
      }
    },
    "description": {
      "$request": {
        "path": "body.description",
        "default": "Mock product order"
      }
    },
    "relatedParty": {
      "$request": {
        "path": "body.relatedParty",
        "default": [
          {
            "id": "customer-001",
            "name": "Mock customer",
            "role": "customer",
            "@type": "RelatedParty",
            "@referredType": "Individual"
          }
        ]
      }
    },
    "billingAccount": {
      "id": {
        "$request": {
          "path": "body.billingAccount.id",
          "default": "BA-001"
        }
      },
      "href": {
        "$request": {
          "path": "body.billingAccount.href",
          "default": {
            "$concat": [
              {
                "$request": "origin"
              },
              "/tmf-api/accountManagement/v4/billingAccount/BA-001"
            ]
          }
        }
      },
      "name": {
        "$request": {
          "path": "body.billingAccount.name",
          "default": "Mock billing account"
        }
      },
      "@referredType": "BillingAccount"
    },
    "productOrderItem": {
      "$request": {
        "path": "body.productOrderItem",
        "default": [
          {
            "id": "1",
            "@type": "ProductOrderItem",
            "state": "acknowledged",
            "action": "add",
            "quantity": 1,
            "productOffering": {
              "id": "offer-mobile-basic",
              "name": "Mobile Basic",
              "@referredType": "ProductOffering"
            }
          }
        ]
      }
    },
    "requestedStartDate": {
      "$request": {
        "path": "body.requestedStartDate",
        "default": "2026-09-01T09:00:00.000Z"
      }
    },
    "expectedCompletionDate": {
      "$request": {
        "path": "body.expectedCompletionDate",
        "default": {
          "$request": {
            "path": "body.requestedCompletionDate",
            "default": "2026-09-05T17:00:00.000Z"
          }
        }
      }
    },
    "requestedCompletionDate": {
      "$request": {
        "path": "body.requestedCompletionDate",
        "default": "2026-09-05T17:00:00.000Z"
      }
    }
  },
  "status": 201,
  "headers": {
    "Location": {
      "$concat": [
        {
          "$request": "origin"
        },
        "/tmf-api/productOrderingManagement/v4/productOrder/",
        {
          "$var": "orderId"
        }
      ]
    },
    "Content-Type": "application/json; charset=utf-8"
  },
  "variables": {
    "orderId": {
      "$request": {
        "path": "headers.idempotency-key",
        "default": {
          "$random": "uuid"
        }
      }
    }
  }
}

Endpoint 03

retrieve-product-order

Retrieves a TMF622 ProductOrder by ID.

Status
200
Priority
0
Paths
2

Bound paths

  • GET order-management.tmfmock.com/tmf622/productOrder/:id
  • GET order-management.tmfmock.com/tmf-api/productOrderingManagement/v4/productOrder/:id

Request conditions

Default

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

Bound response rule

JSON formula 
{
  "body": {
    "id": {
      "$var": "orderId"
    },
    "href": {
      "$concat": [
        {
          "$request": "origin"
        },
        "/tmf-api/productOrderingManagement/v4/productOrder/",
        {
          "$var": "orderId"
        }
      ]
    },
    "@type": "ProductOrder",
    "state": {
      "$var": "state"
    },
    "category": "consumer",
    "priority": "3",
    "orderDate": "2026-08-31T00:00:00.000Z",
    "externalId": {
      "$concat": [
        "CRM-",
        {
          "$var": "orderId"
        }
      ]
    },
    "description": "Mock product order",
    "relatedParty": [
      {
        "id": "customer-001",
        "name": "Mock customer",
        "role": "customer",
        "@type": "RelatedParty",
        "@referredType": "Individual"
      }
    ],
    "billingAccount": {
      "id": "BA-001",
      "href": {
        "$concat": [
          {
            "$request": "origin"
          },
          "/tmf-api/accountManagement/v4/billingAccount/BA-001"
        ]
      },
      "name": "Mock billing account",
      "@referredType": "BillingAccount"
    },
    "productOrderItem": [
      {
        "id": "1",
        "@type": "ProductOrderItem",
        "state": {
          "$var": "state"
        },
        "action": "add",
        "quantity": 1,
        "productOffering": {
          "id": "offer-mobile-basic",
          "name": "Mobile Basic",
          "@referredType": "ProductOffering"
        }
      }
    ],
    "requestedStartDate": "2026-09-01T09:00:00.000Z",
    "expectedCompletionDate": "2026-09-05T17:00:00.000Z",
    "requestedCompletionDate": "2026-09-05T17:00:00.000Z"
  },
  "status": 200,
  "headers": {
    "Content-Type": "application/json; charset=utf-8"
  },
  "variables": {
    "state": {
      "$request": {
        "path": "query.state",
        "default": "inProgress"
      }
    },
    "orderId": {
      "$request": "params.id"
    }
  }
}

Endpoint 04

patch-product-order

Partially updates a TMF622 ProductOrder by ID.

Status
200
Priority
0
Paths
2

Bound paths

  • PATCH order-management.tmfmock.com/tmf622/productOrder/:id
  • PATCH order-management.tmfmock.com/tmf-api/productOrderingManagement/v4/productOrder/:id

Request conditions

Default

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

Bound response rule

JSON formula 
{
  "body": {
    "id": {
      "$var": "orderId"
    },
    "href": {
      "$concat": [
        {
          "$request": "origin"
        },
        "/tmf-api/productOrderingManagement/v4/productOrder/",
        {
          "$var": "orderId"
        }
      ]
    },
    "@type": "ProductOrder",
    "state": {
      "$var": "state"
    },
    "category": {
      "$request": {
        "path": "body.category",
        "default": "consumer"
      }
    },
    "priority": {
      "$request": {
        "path": "body.priority",
        "default": "3"
      }
    },
    "orderDate": "2026-08-31T00:00:00.000Z",
    "externalId": {
      "$request": {
        "path": "body.externalId",
        "default": {
          "$concat": [
            "CRM-",
            {
              "$var": "orderId"
            }
          ]
        }
      }
    },
    "description": {
      "$request": {
        "path": "body.description",
        "default": "Updated mock product order"
      }
    },
    "relatedParty": {
      "$request": {
        "path": "body.relatedParty",
        "default": [
          {
            "id": "customer-001",
            "name": "Mock customer",
            "role": "customer",
            "@type": "RelatedParty",
            "@referredType": "Individual"
          }
        ]
      }
    },
    "billingAccount": {
      "$request": {
        "path": "body.billingAccount",
        "default": {
          "id": "BA-001",
          "href": {
            "$concat": [
              {
                "$request": "origin"
              },
              "/tmf-api/accountManagement/v4/billingAccount/BA-001"
            ]
          },
          "name": "Mock billing account",
          "@referredType": "BillingAccount"
        }
      }
    },
    "productOrderItem": {
      "$request": {
        "path": "body.productOrderItem",
        "default": [
          {
            "id": "1",
            "@type": "ProductOrderItem",
            "state": "inProgress",
            "action": "add",
            "quantity": 1,
            "productOffering": {
              "id": "offer-mobile-basic",
              "name": "Mobile Basic",
              "@referredType": "ProductOffering"
            }
          }
        ]
      }
    },
    "requestedStartDate": {
      "$request": {
        "path": "body.requestedStartDate",
        "default": "2026-09-01T09:00:00.000Z"
      }
    },
    "expectedCompletionDate": {
      "$request": {
        "path": "body.expectedCompletionDate",
        "default": "2026-09-05T17:00:00.000Z"
      }
    },
    "requestedCompletionDate": {
      "$request": {
        "path": "body.requestedCompletionDate",
        "default": "2026-09-05T17:00:00.000Z"
      }
    }
  },
  "status": 200,
  "headers": {
    "Content-Type": "application/json; charset=utf-8"
  },
  "variables": {
    "state": {
      "$request": {
        "path": "body.state",
        "default": "inProgress"
      }
    },
    "orderId": {
      "$request": "params.id"
    }
  }
}

Endpoint 05

delete-product-order

Deletes a TMF622 ProductOrder by ID for administration scenarios.

Status
204
Priority
0
Paths
2

Bound paths

  • DELETE order-management.tmfmock.com/tmf622/productOrder/:id
  • DELETE order-management.tmfmock.com/tmf-api/productOrderingManagement/v4/productOrder/:id

Request conditions

Default

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

Bound response rule

JSON formula 
{
  "status": 204,
  "headers": {}
}

Endpoint 06

list-cancel-product-orders

Lists TMF622 CancelProductOrder task resources with bounded mock pagination.

Status
200
Priority
0
Paths
2

Bound paths

  • GET order-management.tmfmock.com/tmf622/cancelProductOrder
  • GET order-management.tmfmock.com/tmf-api/productOrderingManagement/v4/cancelProductOrder

Request conditions

Default

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

Bound response rule

JSON formula 
{
  "body": {
    "$repeat": {
      "max": 100,
      "min": 1,
      "count": {
        "$var": "count"
      },
      "template": {
        "id": {
          "$concat": [
            "CPO-",
            {
              "$var": "number"
            }
          ]
        },
        "href": {
          "$concat": [
            {
              "$request": "origin"
            },
            "/tmf-api/productOrderingManagement/v4/cancelProductOrder/CPO-",
            {
              "$var": "number"
            }
          ]
        },
        "@type": "CancelProductOrder",
        "state": "done",
        "productOrder": {
          "id": {
            "$concat": [
              "PO-",
              {
                "$var": "number"
              }
            ]
          },
          "href": {
            "$concat": [
              {
                "$request": "origin"
              },
              "/tmf-api/productOrderingManagement/v4/productOrder/PO-",
              {
                "$var": "number"
              }
            ]
          },
          "@referredType": "ProductOrder"
        },
        "cancellationReason": "Customer request",
        "effectiveCancellationDate": "2026-09-01T09:15:00.000Z",
        "requestedCancellationDate": "2026-09-01T09:00:00.000Z"
      }
    }
  },
  "status": 200,
  "headers": {
    "Content-Type": "application/json; charset=utf-8",
    "X-Total-Count": {
      "$var": "count"
    },
    "X-Result-Count": {
      "$var": "count"
    }
  },
  "variables": {
    "count": {
      "$request": {
        "max": 100,
        "min": 1,
        "path": "query.limit",
        "type": "integer",
        "default": 2
      }
    }
  }
}

Endpoint 07

create-cancel-product-order

Creates a TMF622 CancelProductOrder task for a referenced product order.

Status
201
Priority
0
Paths
2

Bound paths

  • POST order-management.tmfmock.com/tmf622/cancelProductOrder
  • POST order-management.tmfmock.com/tmf-api/productOrderingManagement/v4/cancelProductOrder

Request conditions

Default

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

Bound response rule

JSON formula 
{
  "body": {
    "id": {
      "$var": "cancelId"
    },
    "href": {
      "$var": "href"
    },
    "@type": "CancelProductOrder",
    "state": "acknowledged",
    "productOrder": {
      "id": {
        "$var": "productOrderId"
      },
      "href": {
        "$request": {
          "path": "body.productOrder.href",
          "default": {
            "$concat": [
              {
                "$request": "origin"
              },
              "/tmf-api/productOrderingManagement/v4/productOrder/",
              {
                "$var": "productOrderId"
              }
            ]
          }
        }
      },
      "@referredType": "ProductOrder"
    },
    "cancellationReason": {
      "$request": {
        "path": "body.cancellationReason",
        "default": "Customer request"
      }
    },
    "effectiveCancellationDate": "2026-09-01T09:15:00.000Z",
    "requestedCancellationDate": {
      "$request": {
        "path": "body.requestedCancellationDate",
        "default": "2026-09-01T09:00:00.000Z"
      }
    }
  },
  "status": 201,
  "headers": {
    "Location": {
      "$var": "href"
    },
    "Content-Type": "application/json; charset=utf-8"
  },
  "variables": {
    "href": {
      "$concat": [
        {
          "$request": "origin"
        },
        "/tmf-api/productOrderingManagement/v4/cancelProductOrder/",
        {
          "$var": "cancelId"
        }
      ]
    },
    "cancelId": {
      "$request": {
        "path": "headers.idempotency-key",
        "default": {
          "$random": "uuid"
        }
      }
    },
    "productOrderId": {
      "$request": {
        "path": "body.productOrder.id",
        "default": "mock-product-order"
      }
    }
  }
}

Endpoint 08

retrieve-cancel-product-order

Retrieves a TMF622 CancelProductOrder task by ID.

Status
200
Priority
0
Paths
2

Bound paths

  • GET order-management.tmfmock.com/tmf622/cancelProductOrder/:id
  • GET order-management.tmfmock.com/tmf-api/productOrderingManagement/v4/cancelProductOrder/:id

Request conditions

Default

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

Bound response rule

JSON formula 
{
  "body": {
    "id": {
      "$var": "cancelId"
    },
    "href": {
      "$concat": [
        {
          "$request": "origin"
        },
        "/tmf-api/productOrderingManagement/v4/cancelProductOrder/",
        {
          "$var": "cancelId"
        }
      ]
    },
    "@type": "CancelProductOrder",
    "state": {
      "$request": {
        "path": "query.state",
        "default": "done"
      }
    },
    "productOrder": {
      "id": {
        "$var": "productOrderId"
      },
      "href": {
        "$concat": [
          {
            "$request": "origin"
          },
          "/tmf-api/productOrderingManagement/v4/productOrder/",
          {
            "$var": "productOrderId"
          }
        ]
      },
      "@referredType": "ProductOrder"
    },
    "cancellationReason": {
      "$request": {
        "path": "query.reason",
        "default": "Customer request"
      }
    },
    "effectiveCancellationDate": "2026-09-01T09:15:00.000Z",
    "requestedCancellationDate": "2026-09-01T09:00:00.000Z"
  },
  "status": 200,
  "headers": {
    "Content-Type": "application/json; charset=utf-8"
  },
  "variables": {
    "cancelId": {
      "$request": "params.id"
    },
    "productOrderId": {
      "$request": {
        "path": "query.productOrderId",
        "default": "mock-product-order"
      }
    }
  }
}

Endpoint 09

register-order-event-listener

Registers a TMF622 event listener callback through the hub resource.

Status
201
Priority
0
Paths
2

Bound paths

  • POST order-management.tmfmock.com/tmf622/hub
  • POST order-management.tmfmock.com/tmf-api/productOrderingManagement/v4/hub

Request conditions

Default

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

Bound response rule

JSON formula 
{
  "body": {
    "id": {
      "$var": "subscriptionId"
    },
    "href": {
      "$var": "href"
    },
    "query": {
      "$request": {
        "path": "body.query",
        "default": "eventType=ProductOrderStateChangeEvent"
      }
    },
    "callback": {
      "$request": {
        "path": "body.callback",
        "default": "https://client.example.test/tmf622/listener"
      }
    }
  },
  "status": 201,
  "headers": {
    "Location": {
      "$var": "href"
    },
    "Content-Type": "application/json; charset=utf-8"
  },
  "variables": {
    "href": {
      "$concat": [
        {
          "$request": "origin"
        },
        "/tmf-api/productOrderingManagement/v4/hub/",
        {
          "$var": "subscriptionId"
        }
      ]
    },
    "subscriptionId": {
      "$request": {
        "path": "headers.idempotency-key",
        "default": {
          "$random": "uuid"
        }
      }
    }
  }
}

Endpoint 10

unregister-order-event-listener

Unregisters a TMF622 event listener callback by subscription ID.

Status
204
Priority
0
Paths
2

Bound paths

  • DELETE order-management.tmfmock.com/tmf622/hub/:id
  • DELETE order-management.tmfmock.com/tmf-api/productOrderingManagement/v4/hub/:id

Request conditions

Default

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

Bound response rule

JSON formula 
{
  "status": 204,
  "headers": {}
}
Incoming traffic

Requests and responses

Waiting for traffic

No requests captured yet.