API Reference > Part II: Authenticate using JWT > Manage orders and consumer accesses > Orders
  

Orders

An order is a request made by a Data User to gain access to a data collection. A Data User's order is reviewed by the stakeholders of the data collection who are responsible for the approval and fulfillment of the order.

Create orders

Use a REST API to create an order in Data Marketplace. You can use this API to create orders only for yourself, not on behalf of other users.

Endpoint and method

The following table describes the connection properties for the API:
Property
Description
Endpoint
/api/v2/orders
Method
POST
For more information about how you can call an API, see Authenticate using JWT.

Request

The following table describes the parameters that you enter in the body of the API payload:
Parameter
Description
Additional Information
externalId
Optional. Enter a reference identifier for the order that you want to create.
If you don't specify a reference identifier, Data Marketplace automatically assigns a unique value to the item. The reference identifier that Data Marketplace automatically generates contains a prefix. The administrator can specify the prefix of the automatically generated reference identifier in Metadata Command Center.
If you want to specify a reference identifier, ensure that you enter a unique value. Ensure that you don't use the prefix value that is configured in Metadata Command Center.
dataCollectionId
Required. Enter the system-generated unique identifier of the data collection for which you want to create the order.
For more information about how you can use an API to get the system-generated unique identifier of a data collection, see Retrieve all data collections.
To get the system-generated unique identifier of a data collection from the Data Marketplace user interface, open the data collection. The data collection page's URL contains the unique identifier.
For example, in the URL https://{{CDMP_URL}}/datacollection/25158afc-3dfb-44ef-8f3e-cec1e171d0f1?dtn=&tab=summary, the unique identifier is 25158afc-3dfb-44ef-8f3e-cec1e171d0f1.
usageContextId
Optional. Enter the system-generated unique identifier of the usage type that you want to use to specify the context in which you intend to use the data after you receive access to the collection.
For more information about how you can use an API to get the system-generated unique identifier of a usage type, see Retrieve usage type.
justification
Required. Enter a brief description of how you intend to use the data after you receive access to the collection.
-
deliveryRequests
Optional. Enter any additional information that pertains to your order.
For example, you can specify the urgency or the preferred delivery method in this field.
-
requestedProvisionedTargetRef
Optional. Enter the system-generated unique identifier of the delivery target that you want a stakeholder to use to deliver the data.
For more information about how you can use an API to get the system-generated unique identifier of a delivery target, see Retrieve all delivery targets.
If you don't specify a value for the requestedProvisionedTargetRef parameter, the order is created without a specific delivery target but rather uses the default delivery template.
For more information about how you can use an API to get the system-generated unique identifier of a delivery template, see Retrieve delivery templates.
costCenter
Optional. Enter your cost center.
-
customAttributes
Specify the custom attribute values for the order.
Whether you must enter a value in a custom attribute or not is determined by how the custom attribute was defined by your administrator in Metadata Command Center.
Custom attributes are additional properties for Data Marketplace items that are defined by your administrator in Metadata Command Center. For more information about custom attributes, see the Create custom attributes for items topic in the Set Up Data Marketplace help.
customAttributes > value
Enter a value for the custom attribute.
-
customAttributes > id
Enter the system-generated unique identifier of the custom attribute.
For more information about how you can retrieve the system-generated unique identifier of a custom attribute, see Retrieve custom attributes.

Example request

The following example shows how you can use an API to create an order:
{
"externalId": "ORD-1",
"dataCollectionId": "b93c4539-a93e-440d-a4b4-95d69b8911e6",
"usageContextId": "b93c4539-a93e-440d-a4b4-95d69b8911e6",
"justification": "Need customer analytics data for Q4 planning and market analysis to improve product recommendations",
"deliveryRequests": "Data should be delivered in Parquet format to S3 bucket s3://analytics-bucket/orders/ on a weekly basis",
"requestedProvisionedTargetRef": "b93c4539-a93e-440d-a4b4-95d69b8911e6",
"costCenter": "US-IT-2025",
"customAttributes": [
{
"value": "PROJ-2024-CUSTOMER-INSIGHTS",
"id": "com.infa.odin.models.custom.ca_2491832487117218775"
}
]
}

Response

When you invoke the API using a REST client, the client displays a response for the parameter values that you have entered.
The following example shows the response of an API call to create an order that requires manual approval and fulfillment by a stakeholder:
{
"id": "d93c4539-a93e-440d-a4b4-95d69b8911e7",
"externalId": "ORD-1",
"justification": "Need customer analytics data for Q4 planning and market analysis to improve product recommendations",
"deliveryRequest": "Data should be delivered in Parquet format to S3 bucket s3://analytics-bucket/orders/ on a weekly basis",
"requestedProvisionedTargetRef": "b93c4539-a93e-440d-a4b4-95d69b8911e6",
"costCenter": "US-IT-2025",
"status": "PENDING",
"assetGroups": [
{
"id": "c1a86a0e-7690-4577-99ab-be4b193e7d90",
"name": "ASIA",
"isInherited": true
}
]
}
The following table describes the parameters of each order that is created that requires manual approval and fulfillment by a stakeholder:
Parameter
Description
id
System-generated unique identifier of the order.
externalId
Reference identifier of the order.
justification
The reason provided at the time of order for requesting access to the data.
deliveryRequests
Additional information that pertains to the order.
requestedProvisionedTargetRef
The delivery target requested by the Data User.
costCenter
Cost center of the Data User that ordered the data collection.
status
Status of the order. An order can have one of the following statuses:
  • - PENDING. The order is submitted.
  • - APPROVED. The order is approved for fulfillment. A stakeholder of the ordered data collection must deliver the data to the Data User.
  • - REJECTED. The order is rejected by a stakeholder of the ordered data collection.
  • - COMPLETE. The ordered data is delivered to the Data User.
  • - CANCELLED. The order is cancelled.
An order that requires manual approval and fulfillment by a stakeholder is created with PENDING status.
assetGroups
Details of the asset group that is assigned to the category that contains the ordered data collection.
assetGroups > id
System-generated identifier of the asset group.
assetGroups > name
Name of the asset group.
assetGroups > isInherited
Indicates whether the asset group is directly assigned to the category or if the asset group is inherited from the category hierarchy.
This parameter can have one of the following values:
  • - true. The asset group is inherited from the category hierarchy.
  • - false. The asset group is directly assigned to the category.
The following example shows the response of an API call to create an order for which the approval and fulfillment is automated:
{
"id": "d93c4539-a93e-440d-a4b4-95d69b8911e7",
"externalId": "ORD-1",
"justification": "Need customer analytics data for Q4 planning and market analysis to improve product recommendations",
"deliveryRequest": "Data should be delivered in Parquet format to S3 bucket s3://analytics-bucket/orders/ on a weekly basis",
"requestedProvisionedTargetRef": "b93c4539-a93e-440d-a4b4-95d69b8911e6",
"costCenter": "US-IT-2025",
"status": "COMPLETE",
"assetGroups": [
{
"id": "c1a86a0e-7690-4577-99ab-be4b193e7d90",
"name": "ASIA",
"isInherited": true
}
],
"consumerAccess": {
"id": "b93c4539-a93e-440d-a4b4-95d69b8911e6",
"externalId": "CAS-123",
"costCenter": "IT-DEPT-001",
"status": "AVAILABLE",
"accessGrantedOn": "2025-08-01",
"assetGroups": [
{
"id": "c1a86a0e-7690-4577-99ab-be4b193e7d90",
"name": "ASIA",
"isInherited": true
}
],
"_links": {
"self": {
"href": "/consumer-accesses/b93c4539-a93e-440d-a4b4-95d69b8911e6"
}
}
}
}
The following table describes the parameters of each order that is created for which the approval and fulfillment is automated:
Parameter
Description
id
System-generated unique identifier of the order.
externalId
Reference identifier of the order.
justification
The reason provided at the time of order for requesting access to the data.
deliveryRequests
Additional information that pertains to the order.
requestedProvisionedTargetRef
The delivery target requested by the Data User.
costCenter
Cost center of the Data User that ordered the data collection.
status
Status of the order. An order can have one of the following statuses:
  • - PENDING. The order is submitted.
  • - APPROVED. The order is approved for fulfillment. A stakeholder of the ordered data collection must deliver the data to the Data User.
  • - REJECTED. The order is rejected by a stakeholder of the ordered data collection.
  • - COMPLETE. The ordered data is delivered to the Data User.
  • - CANCELLED. The order is cancelled.
An order for which the approval and fulfillment is automated is created with COMPLETE status.
assetGroups
Details of the asset group that is assigned to the category that contains the ordered data collection.
assetGroups > id
System-generated identifier of the asset group.
assetGroups > name
Name of the asset group.
assetGroups > isInherited
Indicates whether the asset group is directly assigned to the category or if the asset group is inherited from the category hierarchy.
This parameter can have one of the following values:
  • - true. The asset group is inherited from the category hierarchy.
  • - false. The asset group is directly assigned to the category.
consumerAccess
Details of the consumer access that is created after the order is fulfilled.

Retrieve an order

Use a REST API to retrieve the details of an individual order in Data Marketplace.

Endpoint and method

The following table describes the connection properties for the API:
Property
Description
Endpoint
/api/v2/orders/<orderId>
<orderId>: Required. Enter the system-generated identifier of the order for which you want to retrieve the details.
For more information about how you can use an API to get the system-generated unique identifier of an order, see Retrieve all orders.
To get the system-generated unique identifier of a order from the Data Marketplace user interface, open the order. The order page's URL contains the unique identifier.
For example, in the URL https://{{CDMP_URL}}/order/3d48daf6-5e75-4e1a-848c-b6821fc33f74?dtn=Order~579b, the unique identifier is 3d48daf6-5e75-4e1a-848c-b6821fc33f74.
Method
GET
For more information about how you can call an API, see Authenticate using JWT.

Request

The following table describes the parameters that you enter in the request query:
Parameter
Description
Additional Information
segments
Optional. Specify the type of details that you want the API request to return.
Enter one or more of the following values:
  • - all. Returns all the details about the order.
  • - dataCollection. Returns the details about the ordered data collection.
  • - customAttributes. Returns the details about the custom attributes that are configured for the order.
  • - stakeholdership. Returns the type of user and role that are assigned as stakeholder on the ordered data collection.
  • - systemAttributes. Returns the details about the order's creation and modification, such as the date when the order was placed, the latest date when it was modified, and so on.
  • - terms. Returns the details about the terms of use snapshot that represents the state of the terms of use of the data collection when the order was placed.
  • - usageContext. Returns the details about the usage type that the Data User selected at the time of order.
By default, the parameter is assigned no value and the API response includes only the basic information about the order such as the ordered data collection, business justification and so on.
Note: The API has no payload.

Example request

The following example shows how you can use an API to retrieve the details of an order:
https://{{CDMP_URL}}/api/v2/orders/2593524d-82f7-4dfd-bc6b-17088c046f9d

Response

When you invoke the API using a REST client, the client displays a response for the parameter values that you have entered.
The following example shows the response of an API call to retrieve the details of an order:
{
"externalId": "ORD-1",
"dataCollectionId": "b93c4539-a93e-440d-a4b4-95d69b8911e6",
"justification": "Need customer analytics data for Q4 planning and market analysis to improve product recommendations",
"deliveryRequests": "Data should be delivered in Parquet format to S3 bucket s3://analytics-bucket/orders/ on a weekly basis",
"requestedProvisionedTargetRef": "b93c4539-a93e-440d-a4b4-95d69b8911e6",
"costCenter": "US-IT-2025",
"assetGroups": [
{
"id": "c1a86a0e-7690-4577-99ab-be4b193e7d90",
"name": "ASIA",
"isInherited": true
}
]
}
The following table describes the parameters of the order that is retrieved:
Parameter
Description
externalId
Reference identifier of the order.
dataCollectionId
System-generated unique identifier of the ordered data collection.
justification
The reason provided at the time of order for requesting access to the data.
deliveryRequests
Additional information that pertains to the order.
requestedProvisionedTargetRef
The delivery target requested by the Data User.
costCenter
Cost center of the Data User that ordered the data collection.
status
Status of the order. An order can have one of the following statuses:
  • - PENDING. The order is submitted.
  • - APPROVED. The order is approved for fulfillment. A stakeholder of the ordered data collection must deliver the data to the Data User.
  • - REJECTED. The order is rejected by a stakeholder of the ordered data collection.
  • - COMPLETE. The ordered data is delivered to the Data User.
  • - CANCELLED. The order is cancelled.
assetGroups
Details of the asset group that is assigned to the category that contains the ordered data collection.
assetGroups > id
System-generated identifier of the asset group.
assetGroups > name
Name of the asset group.
assetGroups > isInherited
Indicates whether the asset group is directly assigned to the category or if the asset group is inherited from the category hierarchy.
This parameter can have one of the following values:
  • - true. The asset group is inherited from the category hierarchy.
  • - false. The asset group is directly assigned to the category.

Retrieve all orders

Use a REST API to retrieve the details of all orders in Data Marketplace.

Endpoint and method

The following table describes the connection properties for the API:
Property
Description
Endpoint
/api/v2/orders/
Method
GET
For more information about how you can call an API, see Authenticate using JWT.

Request

The following table describes the parameters that you enter in the request query:
Parameter
Description
Additional Information
segments
Optional. Specify the type of details that you want the API request to return.
Enter one or more of the following values:
  • - all. Returns all the details about each order that is retrieved.
  • - dataCollection. Returns the details about the ordered data collection.
  • - customAttributes. Returns the details about the custom attributes that are configured for an order.
  • - stakeholdership. Returns the type of user and role that are assigned as stakeholder on the ordered data collection.
  • - systemAttributes. Returns the details about an order's creation and modification, such as the date when the order was placed, the latest date when it was modified, and so on.
  • - terms. Returns the details about the terms of use snapshot that represents the state of the terms of use of the data collection when the order was placed.
  • - usageContext. Returns the details about the usage type that the Data User selected at the time of order.
By default, the parameter is assigned no value and the API response includes only the basic information about the order such as the ordered data collection, business justification and so on.
offset
Optional. Specify the starting index for the paginated results.
Default value is 0.
limit
Optional. Specify the maximum number of results that are displayed on a page.
Default value is 20.
Maximum value is 200.
sortby
Optional. Specify the parameters to sort the search results.
Enter one of the following values:
  • - id
  • - justification
  • - status
  • - createdBy
  • - createdOn
  • - modifiedBy
  • - modifiedOn
Default value is modifiedOn.
sortOrder
Optional. Set the sorting order of the search results.
Enter one of the following values:
  • - To sort the search results by ascending order, enter asc.
  • - To sort the search results by descending order, enter desc.
Default value is desc.
Note: The API has no payload.

Example request

The following example shows how you can use an API to retrieve the details of all orders:
https://{{CDMP_URL}}/api/v2/orders

Response

When you invoke the API using a REST client, the client displays a response for the parameter values that you have entered.
The following example shows the response of an API call to retrieve the details of all orders:
{
"pageInfo": {
"offset": 40,
"limit": 20,
"totalCount": 120
},
"links": {
"self": {
"href": "/orders?offset=40&limit=20"
},
"first": {
"href": "/orders?offset=0&limit=20"
},
"next": {
"href": "/orders?offset=60&limit=20"
},
"previous": {
"href": "/orders?offset=20&limit=20"
},
"last": {
"href": "/orders?offset=100&limit=20"
}
},
"items": {
"externalId": "ORD-1",
"dataCollectionId": "b93c4539-a93e-440d-a4b4-95d69b8911e6",
"justification": "Need customer analytics data for Q4 planning and market analysis to improve product recommendations",
"deliveryRequests": "Data should be delivered in Parquet format to S3 bucket s3://analytics-bucket/orders/ on a weekly basis",
"requestedProvisionedTargetRef": "b93c4539-a93e-440d-a4b4-95d69b8911e6",
"costCenter": "US-IT-2025",
"assetGroups": [
{
"id": "c1a86a0e-7690-4577-99ab-be4b193e7d90",
"name": "ASIA",
"isInherited": true
}
]
}
}
The following table describes the parameters of each order that is retrieved:
Parameter
Description
pageInfo > offset
Starting index of the paginated results.
pageInfo > limit
The maximum number of results that are displayed on a page.
pageInfo > totalCount
Number of orders retrieved.
links > self > href
The API that was invoked to generate this response.
links > first > href
The API endpoint that you can use to retrieve the search results that are displayed on the first page.
links > next > href
The API endpoint that you can use to retrieve the search results from the page following the one you currently have open.
links > previous > href
The API endpoint that you can use to retrieve the search results from the page prior to the one you currently have open.
links > last > href
The API endpoint that you can use to retrieve the search results that are displayed on the last page.
externalId
Reference identifier of the order.
dataCollectionId
System-generated unique identifier of the ordered data collection.
justification
The reason provided at the time of order for requesting access to the data.
deliveryRequests
Additional information that pertains to the order.
requestedProvisionedTargetRef
The delivery target requested by the Data User.
costCenter
Cost center of the Data User that ordered the data collection.
status
Status of the order. An order can have one of the following statuses:
  • - PENDING. The order is submitted.
  • - APPROVED. The order is approved for fulfillment. A stakeholder of the ordered data collection must deliver the data to the Data User.
  • - REJECTED. The order is rejected by a stakeholder of the ordered data collection.
  • - COMPLETE. The ordered data is delivered to the Data User.
  • - CANCELLED. The order is cancelled.
assetGroups
Details of the asset group that is assigned to the category that contains the ordered data collection.
assetGroups > id
System-generated identifier of the asset group.
assetGroups > name
Name of the asset group.
assetGroups > isInherited
Indicates whether the asset group is directly assigned to the category or if the asset group is inherited from the category hierarchy.
This parameter can have one of the following values:
  • - true. The asset group is inherited from the category hierarchy.
  • - false. The asset group is directly assigned to the category.

Approve orders

Use REST APIs to approve orders in Data Marketplace.

Endpoint and method

The following table describes the connection properties for the API:
Property
Description
Endpoint
/api/v2/orders/<orderId>/approve
<orderId>: Required. Enter the system-generated identifier of the order that you want to approve.
For more information about how you can use an API to get the system-generated unique identifier of an order, see Retrieve all orders.
To get the system-generated unique identifier of a order from the Data Marketplace user interface, open the order. The order page's URL contains the unique identifier.
For example, in the URL https://{{CDMP_URL}}/order/3d48daf6-5e75-4e1a-848c-b6821fc33f74?dtn=Order~579b, the unique identifier is 3d48daf6-5e75-4e1a-848c-b6821fc33f74.
Method
PATCH
For more information about how you can call an API, see Authenticate using JWT.

Request

The following table describes the parameters that you enter in the body of the API payload:
Parameter
Description
Additional Information
comment
Optional. Enter a comment about the action taken.
-
costCenter
Optional. Specify the cost center of the Data User that placed the order or modify the cost center value specified by the Data User.
-
customAttributes
Specify the custom attribute values for the order or modify the custom attribute values specified by the Data User at the time of order.
Whether you must enter a value in a custom attribute or not is determined by how the custom attribute was defined by your administrator in Metadata Command Center.
Custom attributes are additional properties for Data Marketplace items that are defined by your administrator in Metadata Command Center. For more information about custom attributes, see the Create custom attributes for items topic in the Set Up Data Marketplace help.
customAttributes > value
Enter the updated value for the custom attribute.
-
customFields > id
Enter the system-generated unique identifier of the custom attribute that you want to modify.
For more information about how you can retrieve the system-generated unique identifier of a custom attribute, see Retrieve custom attributes.

Example request

The following example shows how you can use an API to approve an order:
https://{{CDMP_URL}}/api/v2/orders/2593524d-82f7-4dfd-bc6b-17088c046f9d/approve

Response

When you invoke the API using a REST client, the client displays a response for the parameter values that you have entered.
If you see the following response code, it means that the order is successfully approved:
204 OK code

Fulfill orders

Use REST APIs to mark orders as fulfilled in Data Marketplace.

Endpoint and method

The following table describes the connection properties for the API:
Property
Description
Endpoint
/api/v2/orders/<orderId>/fulfill
<orderId>: Required. Enter the system-generated identifier of the order that you want to mark as fulfilled.
For more information about how you can use an API to get the system-generated unique identifier of an order, see Retrieve all orders.
To get the system-generated unique identifier of a order from the Data Marketplace user interface, open the order. The order page's URL contains the unique identifier.
For example, in the URL https://{{CDMP_URL}}/order/3d48daf6-5e75-4e1a-848c-b6821fc33f74?dtn=Order~579b, the unique identifier is 3d48daf6-5e75-4e1a-848c-b6821fc33f74.
Method
PATCH
For more information about how you can call an API, see Authenticate using JWT.

Request

The following table describes the parameters that you enter in the body of the API payload:
Parameter
Description
Additional Information
comment
Optional. Enter a comment about the action taken.
-
deliveryTargetId
Required. Enter the system generated unique identifier of the delivery target that you want to use to deliver the data.
For more information about how you can use an API to get the system-generated unique identifier of a delivery target, see Retrieve all delivery targets.
costCenter
Optional. Specify the cost center of the Data User that placed the order or modify the cost center value specified by the Data User.
-
customAttributes
Specify the custom attribute values for the order or modify the custom attribute values specified by the Data User at the time of order.
Whether you must enter a value in a custom attribute or not is determined by how the custom attribute was defined by your administrator in Metadata Command Center.
Custom attributes are additional properties for Data Marketplace items that are defined by your administrator in Metadata Command Center. For more information about custom attributes, see the Create custom attributes for items topic in the Set Up Data Marketplace help.
customAttributes > value
Enter the updated value for the custom attribute.
-
customFields > id
Enter the system-generated unique identifier of the custom attribute that you want to modify.
For more information about how you can retrieve the system-generated unique identifier of a custom attribute, see Retrieve custom attributes.

Example request

The following example shows how you can use an API to mark an order as fulfilled:
{
"comment": "Order fulfilled.",
"deliveryTargetId": "b93c4539-a93e-440d-a4b4-95d69b8911e6",
"costCenter": "MARKETING-2025",
"customAttributes": [
{
"value": "PROJ-2024-CUSTOMER-INSIGHTS",
"id": "com.infa.odin.models.custom.ca_2491832487117218775"
}
]
}

Response

When you invoke the API using a REST client, the client displays a response for the parameter values that you have entered.
The following table describes the parameters of each order that is marked as fulfilled:
{
"id": "d93c4539-a93e-440d-a4b4-95d69b8933e6",
"externalId": "CAS-123",
"costCenter": "IT-DEPT-001",
"status": "AVAILABLE",
"accessGrantedOn": "2025-08-01",
"consumer":
{
"stakeholderId": "jaXM6NrqsKXffdwg2NkTMR",
"userType": "USER",
"roleId": "Stakeholder_Role_Marketplace_Editor",
"isInherited": false
},
"assetGroups": [
{
"id": "c1a86a0e-7690-4577-99ab-be4b193e7d90",
"name": "ASIA",
"isInherited": true
}
]
}
Parameter
Description
id
System-generated unique identifier of the consumer access that is created upon order fulfillment.
externalId
Reference identifier of the consumer access.
costCenter
Cost center of the Data User that was granted access to the data collection.
status
Status of the consumer access.
A consumer access can have the following statuses:
  • - AVAILABLE. The Data User has access to the data collection.
  • - PENDING_WITHDRAW. A request is submitted to withdraw the Data User's access to the data collection.
  • - WITHDRAWN. The Data User's access to the data collection is withdrawn.
accessGrantedOn
Date on which the Data User was granted access to the data collection.
consumer
Details about the Data User that was granted access to the data collection.
assetGroups
Details of the asset group that is assigned to the category that contains the data collection that is associated with consumer access.
assetGroups > id
System-generated identifier of the asset group.
assetGroups > name
Name of the asset group.
assetGroups > isInherited
Indicates whether the asset group is directly assigned to the category or if the asset group is inherited from the category hierarchy.
This parameter can have one of the following values:
  • - true. The asset group is inherited from the category hierarchy.
  • - false. The asset group is directly assigned to the category.

Cancel orders

Use REST APIs to cancel orders in Data Marketplace.

Endpoint and method

The following table describes the connection properties for the API:
Property
Description
Endpoint
/api/v2/orders/<orderId>/cancel
<orderId>: Required. Enter the system-generated identifier of the order that you want to cancel.
For more information about how you can use an API to get the system-generated unique identifier of an order, see Retrieve all orders.
To get the system-generated unique identifier of a order from the Data Marketplace user interface, open the order. The order page's URL contains the unique identifier.
For example, in the URL https://{{CDMP_URL}}/order/3d48daf6-5e75-4e1a-848c-b6821fc33f74?dtn=Order~579b, the unique identifier is 3d48daf6-5e75-4e1a-848c-b6821fc33f74.
Method
PATCH
For more information about how you can call an API, see Authenticate using JWT.

Request

The following table describes the parameters that you enter in the body of the API payload:
Parameter
Description
comment
Optional. Enter a comment about the action taken.

Example request

The following example shows how you can use an API to cancel an order:
https://{{CDMP_URL}}/api/v2/orders/2593524d-82f7-4dfd-bc6b-17088c046f9d/cancel

Response

When you invoke the API using a REST client, the client displays a response for the parameter values that you have entered.
If you see the following response code, it means that the order is successfully cancelled:
204 OK code

Reject orders

Use REST APIs to reject orders in Data Marketplace.

Endpoint and method

The following table describes the connection properties for the API:
Property
Description
Endpoint
/api/v2/orders/<orderId>/reject
<orderId>: Required. Enter the system-generated identifier of the order that you want to reject.
For more information about how you can use an API to get the system-generated unique identifier of an order, see Retrieve all orders.
To get the system-generated unique identifier of a order from the Data Marketplace user interface, open the order. The order page's URL contains the unique identifier.
For example, in the URL https://{{CDMP_URL}}/order/3d48daf6-5e75-4e1a-848c-b6821fc33f74?dtn=Order~579b, the unique identifier is 3d48daf6-5e75-4e1a-848c-b6821fc33f74.
Method
PATCH
For more information about how you can call an API, see Authenticate using JWT.

Request

The following table describes the parameters that you enter in the body of the API payload:
Parameter
Description
comment
Optional. Enter a comment about the action taken.

Example request

The following example shows how you can use an API to reject an order:
https://{{CDMP_URL}}/api/v2/orders/2593524d-82f7-4dfd-bc6b-17088c046f9d/reject

Response

When you invoke the API using a REST client, the client displays a response for the parameter values that you have entered.
If you see the following response code, it means that the order is successfully rejected:
204 OK code

Delete orders

If you placed an order accidentally or if an order is obsolete, you can use a REST API to delete the order.

Endpoint and method

The following table describes the connection properties for the API:
Property
Description
Endpoint
/api/v2/orders/<orderId>
<orderId>: Required. Enter the system-generated identifier of the order that you want to delete.
For more information about how you can use an API to get the system-generated unique identifier of an order, see Retrieve all orders.
To get the system-generated unique identifier of a order from the Data Marketplace user interface, open the order. The order page's URL contains the unique identifier.
For example, in the URL https://{{CDMP_URL}}/order/3d48daf6-5e75-4e1a-848c-b6821fc33f74?dtn=Order~579b, the unique identifier is 3d48daf6-5e75-4e1a-848c-b6821fc33f74.
Method
DELETE
Note: To delete a fulfilled order, ensure that you have already deleted its associated consumer access. For more information about how you can delete a consumer access, see Delete consumer accesses.
For more information about how you can call an API, see Authenticate using JWT.

Request

Note: The API has no payload.

Example request

The following example shows how you can use an API to delete an order:
https://{{CDMP_URL}}/api/v2/orders/2593524d-82f7-4dfd-bc6b-17088c046f9d

Response

When you invoke the API using a REST client, the client displays a response for the parameter values that you have entered.
If you see the following response code, it means that the order is successfully deleted:
204 OK code