openapi: 3.2.0 info: title: Mef Modify Product Order Item Requested Delivery Date API version: '1.0' description: 'Operations tagged modifyProductOrderItemRequestedDeliveryDate across 2 of this provider''s published API definitions: mef-lso-cantata-product-order-management-openapi.yml, mef-lso-sonata-product-order-management-openapi.yml. Each path carries the servers of the definition it was published in.' servers: - url: https://{serverBase}/mefApi/cantata/productOrderingManagement/v6/ variables: serverBase: description: The base of Seller's URL. default: mplify.net - url: https://{serverBase}/mefApi/sonata/productOrderingManagement/v11/ variables: serverBase: description: The base of Seller's URL. default: mplify.net tags: - name: modifyProductOrderItemRequestedDeliveryDate paths: /modifyProductOrderItemRequestedDeliveryDate: get: tags: - modifyProductOrderItemRequestedDeliveryDate summary: Lists or finds ModifyProductOrderItemRequestedDeliveryDate objects description: This operation lists or finds ModifyProductOrderItemRequestedDeliveryDate entities operationId: listModifyProductOrderItemRequestedDeliveryDate parameters: - name: productOrderId in: query required: false schema: type: string - name: state in: query required: false schema: type: string enum: - acknowledged - done - done.declined - inProgress.assessingCharge - rejected - name: expediteIndicator in: query description: Indicates that expedited treatment is requested. required: false schema: type: boolean - name: requestedCompletionDate.gt in: query description: Identifies the Buyer's desired due date (requested delivery date) - greater than required: false schema: type: string format: date-time - name: requestedCompletionDate.lt in: query description: Identifies the Buyer's desired due date (requested delivery date) - lesser than required: false schema: type: string format: date-time - name: creationDate.gt in: query description: The date on which the Seller assigned the Modify Product Order Item Requested Delivery Data Identifier - greater than required: false schema: type: string format: date-time - name: creationDate.lt in: query description: The date on which the Seller assigned the Modify Product Order Item Requested Delivery Data Identifier - lesser than required: false schema: type: string format: date-time - name: buyerId in: 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. required: false schema: type: string - name: sellerId in: 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. required: false schema: type: string - name: offset in: query description: Requested index for start of item to be provided in response requested by client. Note that the index starts with "0". required: false schema: type: integer format: int32 - name: limit in: query description: Requested number of items to be provided in response requested by client required: false schema: type: integer format: int32 responses: '200': description: Success headers: X-Pagination-Throttled: description: 'Used to indicate that result page was throttled to maximum possible size and there are additional results that can be fetched ' schema: type: boolean X-Total-Count: description: 'The total number of matching items. E.g. if there are 50 matching items in total, but the request has offset=10 and limit=10, then the X-Total-Count is 50. ' schema: type: integer X-Result-Count: description: The number of items included in the response schema: type: integer content: application/json;charset=utf-8: schema: type: array items: $ref: '#/components/schemas/MEFModifyProductOrderItemRequestedDeliveryDate' '400': description: Bad Request content: application/json;charset=utf-8: schema: $ref: '#/components/schemas/Error400' '401': description: Unauthorized content: application/json;charset=utf-8: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json;charset=utf-8: schema: $ref: '#/components/schemas/Error403' '500': description: Internal Server Error content: application/json;charset=utf-8: schema: $ref: '#/components/schemas/Error500' '501': description: Method not implemented. content: application/json;charset=utf-8: schema: $ref: '#/components/schemas/Error501' post: tags: - modifyProductOrderItemRequestedDeliveryDate summary: Creates a ModifyProductOrderItemRequestedDeliveryDate description: This operation creates a ModifyProductOrderItemRequestedDeliveryDate entity. operationId: createModifyProductOrderItemRequestedDeliveryDate parameters: - name: buyerId in: 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. required: false schema: type: string - name: sellerId in: 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. required: false schema: type: string requestBody: description: The ModifyProductOrderItemRequestedDeliveryDate to be created content: application/json;charset=utf-8: schema: $ref: '#/components/schemas/MEFModifyProductOrderItemRequestedDeliveryDate_Create' required: true responses: '201': description: Created content: application/json;charset=utf-8: schema: $ref: '#/components/schemas/MEFModifyProductOrderItemRequestedDeliveryDate' '400': description: Bad Request content: application/json;charset=utf-8: schema: $ref: '#/components/schemas/Error400' '401': description: Unauthorized content: application/json;charset=utf-8: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json;charset=utf-8: schema: $ref: '#/components/schemas/Error403' '422': description: Unprocessable entity due to the business validation problems content: application/json;charset=utf-8: schema: type: array items: $ref: '#/components/schemas/Error422' '500': description: Internal Server Error content: application/json;charset=utf-8: schema: $ref: '#/components/schemas/Error500' '501': description: Method not implemented. content: application/json;charset=utf-8: schema: $ref: '#/components/schemas/Error501' servers: - url: https://{serverBase}/mefApi/cantata/productOrderingManagement/v6/ variables: serverBase: description: The base of Seller's URL. default: mplify.net /modifyProductOrderItemRequestedDeliveryDate/{id}: get: tags: - modifyProductOrderItemRequestedDeliveryDate summary: Retrieves a ModifyProductOrderItemRequestedDeliveryDate by ID description: This operation retrieves a ModifyProductOrderItemRequestedDeliveryDate entity. operationId: retrieveModifyProductOrderItemRequestedDeliveryDate parameters: - name: id in: path description: Identifier of the ModifyProductOrderItemRequestedDeliveryDate required: true schema: type: string - name: buyerId in: 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. required: false schema: type: string - name: sellerId in: 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. required: false schema: type: string responses: '200': description: Success content: application/json;charset=utf-8: schema: $ref: '#/components/schemas/MEFModifyProductOrderItemRequestedDeliveryDate' '400': description: Bad Request content: application/json;charset=utf-8: schema: $ref: '#/components/schemas/Error400' '401': description: Unauthorized content: application/json;charset=utf-8: schema: $ref: '#/components/schemas/Error401' '403': description: Forbidden content: application/json;charset=utf-8: schema: $ref: '#/components/schemas/Error403' '404': description: Not Found content: application/json;charset=utf-8: schema: $ref: '#/components/schemas/Error404' '500': description: Internal Server Error content: application/json;charset=utf-8: schema: $ref: '#/components/schemas/Error500' '501': description: Method not implemented. content: application/json;charset=utf-8: schema: $ref: '#/components/schemas/Error501' servers: - url: https://{serverBase}/mefApi/cantata/productOrderingManagement/v6/ variables: serverBase: description: The base of Seller's URL. default: mplify.net components: schemas: Error422: description: Unprocessable entity due to a business validation problem. (https://tools.ietf.org/html/rfc4918#section-11.2) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: "One of the following error codes:\n - missingProperty: The property the Seller has expected is not present in the payload\n - invalidValue: The property has an incorrect value\n - invalidFormat: The property value does not comply with the expected value format\n - referenceNotFound: The object referenced by the property cannot be identified in the Seller system\n - unexpectedProperty: Additional property, not expected by the Seller has been provided\n - tooManyRecords: the number of records to be provided in the response exceeds the Seller's threshold.\n - otherIssue: Other problem was identified (detailed information provided in a reason)\n" $ref: '#/components/schemas/Error422Code' propertyPath: description: 'A pointer to a particular property of the payload that caused the validation issue. It is highly recommended that this property should be used. Defined using JavaScript Object Notation (JSON) Pointer (https://tools.ietf.org/html/rfc6901). ' type: string required: - code Error400Code: description: 'One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter - missingQueryValue: The URI is missing a required query-string parameter value - invalidQuery: The query section of the URI is invalid. - invalidBody: The request has an invalid body' type: string enum: - missingQueryParameter - missingQueryValue - invalidQuery - invalidBody Error422Code: description: "One of the following error codes:\n - missingProperty: The property the Seller has expected is not present in the payload\n - invalidValue: The property has an incorrect value\n - invalidFormat: The property value does not comply with the expected value format\n - referenceNotFound: The object referenced by the property cannot be identified in the Seller system\n - unexpectedProperty: Additional property, not expected by the Seller has been provided\n - tooManyRecords: the number of records to be provided in the response exceeds the Seller's threshold.\n - otherIssue: Other problem was identified (detailed information provided in a reason)\n" type: string enum: - missingProperty - invalidValue - invalidFormat - referenceNotFound - unexpectedProperty - tooManyRecords - otherIssue Error404: description: Resource for the requested path not found. (https://tools.ietf.org/html/rfc7231#section-6.5.4) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'The following error code: - notFound: A current representation for the target resource not found' type: string enum: - notFound required: - code Error403: description: Forbidden. This code indicates that the server understood the request but refuses to authorize it. (https://tools.ietf.org/html/rfc7231#section-6.5.3) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'This code indicates that the server understood the request but refuses to authorize it because of one of the following error codes: - accessDenied: Access denied - forbiddenRequester: Forbidden requester - tooManyUsers: Too many users' $ref: '#/components/schemas/Error403Code' required: - code MEFProductOrderItemRef: description: It's a ProductOrder item type: object properties: productOrderHref: description: Reference of the related ProductOrder. type: string productOrderId: description: Unique identifier of a ProductOrder. type: string productOrderItemId: description: Id of an Item within the Product Order type: string required: - productOrderId - productOrderItemId Error401: description: Unauthorized. (https://tools.ietf.org/html/rfc7235#section-3.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired' $ref: '#/components/schemas/Error401Code' required: - code Error401Code: description: 'One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired' type: string enum: - missingCredentials - invalidCredentials MEFModifyProductOrderItemRequestedDeliveryDate: description: A response to a request initiated by the Buyer to modify the Requested Completion Date or the Expedite Indicator of a Product Order Item. type: object properties: creationDate: description: Date that the Modify Product Order Item Requested Delivery Date was created in the Seller's system and the id was assigned type: string format: date-time expediteIndicator: description: Indicates that expedited treatment is requested. Set by the Buyer. Default Value = FALSE. If this is set to TRUE, the Buyer sets the Requested Completion Date to the expedited date type: boolean default: false href: description: 'Hyperlink to the modification request. Hyperlink MAY be used by the Seller in responses Hyperlink MUST be ignored by the Seller in case it is provided by the Buyer in a request ' type: string id: description: Unique identifier for the MEFModifyProductOrderItemRequestedDeliveryDate that is generated by the Seller when the MEFModifyProductOrderItemRequestedDeliveryDate request is moved to the 'acknowledged' state. type: string productOrderItem: description: A reference to the Product Order Item to be modified. $ref: '#/components/schemas/MEFProductOrderItemRef' requestedCompletionDate: description: Identifies the Buyer's desired due date (requested delivery date) type: string format: date-time state: description: The state of the Modify Product Order Item Requested Delivery Date request $ref: '#/components/schemas/MEFChargeableTaskStateType' required: - creationDate - id - productOrderItem - state Error400: description: Bad Request. (https://tools.ietf.org/html/rfc7231#section-6.5.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter - missingQueryValue: The URI is missing a required query-string parameter value - invalidQuery: The query section of the URI is invalid. - invalidBody: The request has an invalid body' $ref: '#/components/schemas/Error400Code' required: - code Error501: description: Not Implemented. Used in case Seller is not supporting an optional operation (https://tools.ietf.org/html/rfc7231#section-6.6.2) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'The following error code: - notImplemented: Method not supported by the server' type: string enum: - notImplemented required: - code Error500: description: Internal Server Error. (https://tools.ietf.org/html/rfc7231#section-6.6.1) allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: description: 'The following error code: - internalError: Internal server error - the server encountered an unexpected condition that prevented it from fulfilling the request.' type: string enum: - internalError required: - code MEFModifyProductOrderItemRequestedDeliveryDate_Create: description: A request initiated by the Buyer to modify the Requested Requested Delivery Date or the Expedite Indicator of a Product Order Item. type: object properties: expediteIndicator: description: Indicates that expedited treatment is requested. Set by the Buyer. Default Value = FALSE. If this is set to TRUE, the Buyer sets the Requested Completion Date to the expedited date type: boolean default: false productOrderItem: description: A reference to the Product Order Item to be modified. $ref: '#/components/schemas/MEFProductOrderItemRef' requestedCompletionDate: description: Identifies the Buyer's desired due date (requested delivery date) type: string format: date-time required: - productOrderItem Error403Code: description: 'This code indicates that the server understood the request but refuses to authorize it because of one of the following error codes: - accessDenied: Access denied - forbiddenRequester: Forbidden requester - tooManyUsers: Too many users' type: string enum: - accessDenied - forbiddenRequester - tooManyUsers Error: description: 'Standard Class used to describe API response error Not intended to be used directly. The `code` in the HTTP header is used as a discriminator for the type of error returned in runtime. ' type: object properties: message: description: Text that provides mode details and corrective actions related to the error. This can be shown to a client user. type: string reason: description: Text that explains the reason for the error. This can be shown to a client user. type: string maxLength: 255 referenceError: description: URL pointing to documentation describing the error type: string format: uri required: - reason MEFChargeableTaskStateType: description: 'The states as defined by TMF622 and extended to meet MEF requirements. | Name | MEF 57.2 Name | Description | | -------------------------- | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | inProgress.assessingCharge | ACCESSING_CHARGE | The Modify Product Order Item Requested Delivery Date request results in a Charge being initiated by the Seller. The Modify Product Order Item Requested Delivery Date remains in this state until the Charge is completed or withdrawn by the Seller. All charges within a Charge that was initiated due to a Modify Product Order Item Requested Delivery Date are considered Blocking charges. If any charge is not accepted by the Buyer, the Modify Product Order Item Requested Delivery Date moves from the `inProgress.assessingCharge` state to the `done.declined` state. | | acknowledged | ACKNOWLEDGED | A Modify Product Order Item Requested Delivery Date request has been received and has passed basic validation. The Modify Product Order Item Requested Delivery Date Identifier is assigned in the `acknowledged` state. Validation of Modify Product Order Item Requested Delivery Date attributes as applicable is completed in the `acknowledged` state. | | done | ACCEPTED | A Modify Product Order Item Requested Delivery Date request has been received, passed all validations, if a Charge is associated all Charge Items have been accepted by the Buyer, and the Product Order Item Completion Date has been updated as requested. | | done.declined | DECLINED | Blocking charges associated with a Modify Product Order Item Requested Delivery Date have been declined by the Buyer. No updates are made to the Product Order Item. | | rejected | REJECTED | A Modify Product Order Item Requested Delivery Date request was submitted by the Buyer, and it has failed any validation checks the Seller performs during the `acknowledged` state. No updates are made to the referenced Product Order Item. ' type: string enum: - acknowledged - done - done.declined - inProgress.assessingCharge - rejected x-refined-from: - mef-lso-cantata-product-order-management-openapi.yml - mef-lso-sonata-product-order-management-openapi.yml