{ "opencollection": "1.0.0", "info": { "name": "Product Ordering Management", "version": "6.0.1" }, "items": [ { "info": { "name": "productOrder", "type": "folder" }, "items": [ { "info": { "name": "Lists or finds ProductOrder objects", "type": "http" }, "http": { "method": "GET", "url": "https://{serverBase}/mefApi/cantata/productOrderingManagement/v6/productOrder", "params": [ { "name": "state", "value": "", "type": "query", "description": "State of the Product Order" }, { "name": "externalId", "value": "", "type": "query", "description": "A number that uniquely identifies an order within the Buyer's enterprise." }, { "name": "projectId", "value": "", "type": "query", "description": "An identifier that is used to group Product Orders that represent a unit of functionality that is important to a Buyer." }, { "name": "orderDate.gt", "value": "", "type": "query", "description": "Date when the order was created greater than" }, { "name": "orderDate.lt", "value": "", "type": "query", "description": "Date when the order was created lesser than" }, { "name": "completionDate.gt", "value": "", "type": "query", "description": "Effective completion date greater than" }, { "name": "completionDate.lt", "value": "", "type": "query", "description": "Effective completion date lesser than" }, { "name": "itemRequestedCompletionDate.gt", "value": "", "type": "query", "description": "This is requested date to get this Product Order Item completed greater than" }, { "name": "itemRequestedCompletionDate.lt", "value": "", "type": "query", "description": "This is requested date to get this Product Order Item completed lesser than" }, { "name": "itemExpectedCompletionDate.gt", "value": "", "type": "query", "description": "Seller planned completion date of the Product Order Item, greater than" }, { "name": "itemExpectedCompletionDate.lt", "value": "", "type": "query", "description": "Seller planned completion date of the Product Order Item, lesser than" }, { "name": "cancellationDate.gt", "value": "", "type": "query", "description": "order cancellation date greater than" }, { "name": "cancellationDate.lt", "value": "", "type": "query", "description": "order cancellation date lesser than" }, { "name": "buyerId", "value": "", "type": "query", "description": "The unique identifier of the organization that is acting as the a Buyer. MUST be specified in the request only when the requester represents more than one Buyer." }, { "name": "sellerId", "value": "", "type": "query", "description": "The unique identifier of the organization that is acting as the Seller. MUST be specified in the request only when the responding entity represents more than one Seller." }, { "name": "offset", "value": "", "type": "query", "description": "Requested index for start of item to be provided in response requested by the client. Note that the index starts with \"0\"." }, { "name": "limit", "value": "", "type": "query", "description": "Requested number of items to be provided in response requested by client" } ] }, "docs": "This operation lists or finds ProductOrder entities" }, { "info": { "name": "Creates a ProductOrder", "type": "http" }, "http": { "method": "POST", "url": "https://{serverBase}/mefApi/cantata/productOrderingManagement/v6/productOrder", "params": [ { "name": "buyerId", "value": "", "type": "query", "description": "The unique identifier of the organization that is acting as the a Buyer. MUST be specified in the request only when the requester represents more than one Buyer." }, { "name": "sellerId", "value": "", "type": "query", "description": "The unique identifier of the organization that is acting as the Seller. MUST be specified in the request only when the responding entity represents more than one Seller." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This operation creates a ProductOrder entity." }, { "info": { "name": "Retrieves a ProductOrder by ID", "type": "http" }, "http": { "method": "GET", "url": "https://{serverBase}/mefApi/cantata/productOrderingManagement/v6/productOrder/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier of the ProductOrder" }, { "name": "buyerId", "value": "", "type": "query", "description": "The unique identifier of the organization that is acting as the a Buyer. MUST be specified in the request only when the requester represents more than one Buyer." }, { "name": "sellerId", "value": "", "type": "query", "description": "The unique identifier of the organization that is acting as the Seller. MUST be specified in the request only when responding entity represents more than one Seller." } ] }, "docs": "This operation retrieves a ProductOrder entity." }, { "info": { "name": "Updates partially a ProductOrder", "type": "http" }, "http": { "method": "PATCH", "url": "https://{serverBase}/mefApi/cantata/productOrderingManagement/v6/productOrder/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier of the ProductOrder" }, { "name": "buyerId", "value": "", "type": "query", "description": "The unique identifier of the organization that is acting as the a Buyer. MUST be specified in the request only when the requester represents more than one Buyer." }, { "name": "sellerId", "value": "", "type": "query", "description": "The unique identifier of the organization that is acting as the Seller. MUST be specified in the request only when responding entity represents more than one Seller." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This operation updates partially a ProductOrder entity." } ] }, { "info": { "name": "cancelProductOrder", "type": "folder" }, "items": [ { "info": { "name": "Lists or finds CancelProductOrder objects", "type": "http" }, "http": { "method": "GET", "url": "https://{serverBase}/mefApi/cantata/productOrderingManagement/v6/cancelProductOrder", "params": [ { "name": "productOrderId", "value": "", "type": "query" }, { "name": "state", "value": "", "type": "query" }, { "name": "cancellationReasonType", "value": "", "type": "query", "description": "Identifies the type of reason, Technical or Commercial, for the Cancellation request" }, { "name": "buyerId", "value": "", "type": "query", "description": "The unique identifier of the organization that is acting as the a Buyer. MUST be specified in the request only when the requester represents more than one Buyer." }, { "name": "sellerId", "value": "", "type": "query", "description": "The unique identifier of the organization that is acting as the Seller. MUST be specified in the request only when responding entity represents more than one Seller." }, { "name": "offset", "value": "", "type": "query", "description": "Requested index for start of item to be provided in response requested by client. Note that the index starts with \"0\"." }, { "name": "limit", "value": "", "type": "query", "description": "Requested number of items to be provided in response requested by client" } ] }, "docs": "This operation lists or finds CancelProductOrder entities" }, { "info": { "name": "Creates a CancelProductOrder", "type": "http" }, "http": { "method": "POST", "url": "https://{serverBase}/mefApi/cantata/productOrderingManagement/v6/cancelProductOrder", "params": [ { "name": "buyerId", "value": "", "type": "query", "description": "The unique identifier of the organization that is acting as the a Buyer. MUST be specified in the request only when the requester represents more than one Buyer." }, { "name": "sellerId", "value": "", "type": "query", "description": "The unique identifier of the organization that is acting as the Seller. MUST be specified in the request only when responding entity represents more than one Seller." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This operation creates a CancelProductOrder entity." }, { "info": { "name": "Retrieves a CancelProductOrder by ID", "type": "http" }, "http": { "method": "GET", "url": "https://{serverBase}/mefApi/cantata/productOrderingManagement/v6/cancelProductOrder/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier of the CancelProductOrder" }, { "name": "buyerId", "value": "", "type": "query", "description": "The unique identifier of the organization that is acting as the a Buyer. MUST be specified in the request only when the requester represents more than one Buyer." }, { "name": "sellerId", "value": "", "type": "query", "description": "The unique identifier of the organization that is acting as the Seller. MUST be specified in the request only when responding entity represents more than one Seller." } ] }, "docs": "This operation retrieves a CancelProductOrder entity." } ] }, { "info": { "name": "charge", "type": "folder" }, "items": [ { "info": { "name": "Lists or finds Charge objects", "type": "http" }, "http": { "method": "GET", "url": "https://{serverBase}/mefApi/cantata/productOrderingManagement/v6/charge", "params": [ { "name": "productOrderId", "value": "", "type": "query", "description": "id of the Product Order this Charge relates to." }, { "name": "productOrderItemId", "value": "", "type": "query", "description": "id of the Product Order Item this Charge relates to." }, { "name": "creationDate.gt", "value": "", "type": "query", "description": "Date that the Charge was created by the Seller (greater than)" }, { "name": "creationDate.lt", "value": "", "type": "query", "description": "Date that the Charge was created by the Seller. (greater than)" }, { "name": "responseDueDate.gt", "value": "", "type": "query", "description": "The date that the Buyer must respond to the Seller's Charge. If there is no response received by the Due Date the Seller will treat all charges as declined (greater than)" }, { "name": "responseDueDate.lt", "value": "", "type": "query", "description": "The date that the Buyer must respond to the Seller's Charge. If there is no response received by the Due Date the Seller will treat all charges as declined (greater than)" }, { "name": "buyerId", "value": "", "type": "query", "description": "The unique identifier of the organization that is acting as the a Buyer. MUST be specified in the request only when the requester represents more than one Buyer." }, { "name": "sellerId", "value": "", "type": "query", "description": "The unique identifier of the organization that is acting as the Seller. MUST be specified in the request only when responding entity represents more than one Seller." }, { "name": "offset", "value": "", "type": "query", "description": "Requested index for start of item to be provided in response requested by client. Note that the index starts with \"0\"." }, { "name": "limit", "value": "", "type": "query", "description": "Requested number of items to be provided in response requested by client" } ] }, "docs": "This operation lists or finds Charge entities" }, { "info": { "name": "Retrieves a Charge by ID", "type": "http" }, "http": { "method": "GET", "url": "https://{serverBase}/mefApi/cantata/productOrderingManagement/v6/charge/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier of the Charge" }, { "name": "buyerId", "value": "", "type": "query", "description": "The unique identifier of the organization that is acting as the a Buyer. MUST be specified in the request only when the requester represents more than one Buyer." }, { "name": "sellerId", "value": "", "type": "query", "description": "The unique identifier of the organization that is acting as the Seller. MUST be specified in the request only when responding entity represents more than one Seller." } ] }, "docs": "This operation retrieves a Charge entity." }, { "info": { "name": "Updates partially a Charge", "type": "http" }, "http": { "method": "PATCH", "url": "https://{serverBase}/mefApi/cantata/productOrderingManagement/v6/charge/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier of the Charge" }, { "name": "buyerId", "value": "", "type": "query", "description": "The unique identifier of the organization that is acting as the a Buyer. MUST be specified in the request only when the requester represents more than one Buyer." }, { "name": "sellerId", "value": "", "type": "query", "description": "The unique identifier of the organization that is acting as the Seller. MUST be specified in the request only when responding entity represents more than one Seller." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This operation updates partially a Charge entity." } ] }, { "info": { "name": "events subscription", "type": "folder" }, "items": [ { "info": { "name": "Register a listener", "type": "http" }, "http": { "method": "POST", "url": "https://{serverBase}/mefApi/cantata/productOrderingManagement/v6/hub", "params": [ { "name": "buyerId", "value": "", "type": "query", "description": "The unique identifier of the organization that is acting as the a Buyer. MUST be specified in the request only when the requester represents more than one Buyer." }, { "name": "sellerId", "value": "", "type": "query", "description": "The unique identifier of the organization that is acting as the Seller. MUST be specified in the request only when responding entity represents more than one Seller." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Sets the communication endpoint address the service instance must use to deliver information about its health state, execution state, failures and metrics." }, { "info": { "name": "Retrieves a Hub by ID", "type": "http" }, "http": { "method": "GET", "url": "https://{serverBase}/mefApi/cantata/productOrderingManagement/v6/hub/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier of the Hub" }, { "name": "buyerId", "value": "", "type": "query", "description": "The unique identifier of the organization that is acting as the a Buyer. MUST be specified in the request only when the requester represents more than one Buyer." }, { "name": "sellerId", "value": "", "type": "query", "description": "The unique identifier of the organization that is acting as the Seller. MUST be specified in the request only when responding entity represents more than one Seller." } ] }, "docs": "This operation retrieves a hub entity." }, { "info": { "name": "Unregister a listener", "type": "http" }, "http": { "method": "DELETE", "url": "https://{serverBase}/mefApi/cantata/productOrderingManagement/v6/hub/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The id of the registered listener" }, { "name": "buyerId", "value": "", "type": "query", "description": "The unique identifier of the organization that is acting as the a Buyer. MUST be specified in the request only when the requester represents more than one Buyer." }, { "name": "sellerId", "value": "", "type": "query", "description": "The unique identifier of the organization that is acting as the Seller. MUST be specified in the request only when responding entity represents more than one Seller." } ] }, "docs": "Resets the communication endpoint address the service instance must use to deliver information about its health state, execution state, failures and metrics." } ] }, { "info": { "name": "modifyProductOrderItemRequestedDeliveryDate", "type": "folder" }, "items": [ { "info": { "name": "Lists or finds ModifyProductOrderItemRequestedDeliveryDate objects", "type": "http" }, "http": { "method": "GET", "url": "https://{serverBase}/mefApi/cantata/productOrderingManagement/v6/modifyProductOrderItemRequestedDeliveryDate", "params": [ { "name": "productOrderId", "value": "", "type": "query" }, { "name": "state", "value": "", "type": "query" }, { "name": "expediteIndicator", "value": "", "type": "query", "description": "Indicates that expedited treatment is requested." }, { "name": "requestedCompletionDate.gt", "value": "", "type": "query", "description": "Identifies the Buyer's desired due date (requested delivery date) - greater than" }, { "name": "requestedCompletionDate.lt", "value": "", "type": "query", "description": "Identifies the Buyer's desired due date (requested delivery date) - lesser than" }, { "name": "creationDate.gt", "value": "", "type": "query", "description": "The date on which the Seller assigned the Modify Product Order Item Requested Delivery Data Identifier - greater than" }, { "name": "creationDate.lt", "value": "", "type": "query", "description": "The date on which the Seller assigned the Modify Product Order Item Requested Delivery Data Identifier - lesser than" }, { "name": "buyerId", "value": "", "type": "query", "description": "The unique identifier of the organization that is acting as the a Buyer. MUST be specified in the request only when the requester represents more than one Buyer." }, { "name": "sellerId", "value": "", "type": "query", "description": "The unique identifier of the organization that is acting as the Seller. MUST be specified in the request only when responding entity represents more than one Seller." }, { "name": "offset", "value": "", "type": "query", "description": "Requested index for start of item to be provided in response requested by client. Note that the index starts with \"0\"." }, { "name": "limit", "value": "", "type": "query", "description": "Requested number of items to be provided in response requested by client" } ] }, "docs": "This operation lists or finds ModifyProductOrderItemRequestedDeliveryDate entities" }, { "info": { "name": "Creates a ModifyProductOrderItemRequestedDeliveryDate", "type": "http" }, "http": { "method": "POST", "url": "https://{serverBase}/mefApi/cantata/productOrderingManagement/v6/modifyProductOrderItemRequestedDeliveryDate", "params": [ { "name": "buyerId", "value": "", "type": "query", "description": "The unique identifier of the organization that is acting as the Buyer. MUST be specified in the request only when the requester represents more than one Buyer." }, { "name": "sellerId", "value": "", "type": "query", "description": "The unique identifier of the organization that is acting as the Seller. MUST be specified in the request only when responding entity represents more than one Seller." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This operation creates a ModifyProductOrderItemRequestedDeliveryDate entity." }, { "info": { "name": "Retrieves a ModifyProductOrderItemRequestedDeliveryDate by ID", "type": "http" }, "http": { "method": "GET", "url": "https://{serverBase}/mefApi/cantata/productOrderingManagement/v6/modifyProductOrderItemRequestedDeliveryDate/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier of the ModifyProductOrderItemRequestedDeliveryDate" }, { "name": "buyerId", "value": "", "type": "query", "description": "The unique identifier of the organization that is acting as the a Buyer. MUST be specified in the request only when the requester represents more than one Buyer." }, { "name": "sellerId", "value": "", "type": "query", "description": "The unique identifier of the organization that is acting as the Seller. MUST be specified in the request only when responding entity represents more than one Seller." } ] }, "docs": "This operation retrieves a ModifyProductOrderItemRequestedDeliveryDate entity." } ] } ], "bundled": true }