Console Connect logo

Product Order Management

Creates a ProductOrder

This operation creates a ProductOrder entity.

Securityx-sonata-buyer-key-and-api-key
Request
query Parameters
buyerId
string

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. Reference: MEF 79 (Sn 8.8)

sellerId
string

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. Reference: MEF 79 (Sn 8.8)

Request Body schema: application/json;charset=utf-8
required

The ProductOrder to be created

externalId
string

An identifier for this order within the Buyer's enterprise.

Array of objects (Note)

Free form text to clarify or explain the Product Order. Only new notes can be entered. The Buyer and Seller cannot modify an existing Note. The Buyer creates a Note when creating the Product Order or when updating it. The Seller may add notes at any time.

projectId
string

An identifier that is used to group Product Orders that is important to the Buyer. A projectId can be used to relate multiple Product Orders together.

required
Array of objects (RelatedContactInformation) non-empty

Contact information of an individual or organization playing a role in this context. (e.g. Product Order Contact: role=productOrderContact; Seller Contact: role=sellerContact) Providing the Product Order Contact in the request is mandatory.

required
Array of objects (MEFProductOrderItem_Create) non-empty

Items contained in the Product Order.

Responses
201

Created (https://tools.ietf.org/html/rfc7231#section-6.3.2)

400

Bad Request

401

Unauthorized

403

Forbidden

422

Unprocessable entity due to the business validation problems

500

Internal Server Error

post/mefApi/sonata/productOrderingManagement/v10/productOrder
Request samples
application/json;charset=utf-8
{
  • "externalId": "string",
  • "note": [
    ],
  • "projectId": "string",
  • "relatedContactInformation": [
    ],
  • "productOrderItem": [
    ]
}
Response samples
application/json;charset=utf-8
{
  • "externalId": "string",
  • "note": [
    ],
  • "projectId": "string",
  • "relatedContactInformation": [
    ],
  • "cancellationCharge": [
    ],
  • "cancellationDate": "2019-08-24T14:15:22Z",
  • "cancellationReason": "string",
  • "completionDate": "2019-08-24T14:15:22Z",
  • "href": "string",
  • "id": "string",
  • "orderDate": "2019-08-24T14:15:22Z",
  • "productOrderItem": [
    ],
  • "state": "acknowledged",
  • "stateChange": [
    ]
}

Retrieves a ProductOrder by ID

This operation retrieves a ProductOrder entity.

Securityx-sonata-buyer-key-and-api-key
Request
path Parameters
id
required
string

Identifier of the ProductOrder

query Parameters
buyerId
string

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. Reference: MEF 79 (Sn 8.8)

sellerId
string

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. Reference: MEF 79 (Sn 8.8)

Responses
200

OK. (https://tools.ietf.org/html/rfc7231#section-6.3.1)

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/mefApi/sonata/productOrderingManagement/v10/productOrder/{id}
Response samples
application/json;charset=utf-8
{
  • "externalId": "string",
  • "note": [
    ],
  • "projectId": "string",
  • "relatedContactInformation": [
    ],
  • "cancellationCharge": [
    ],
  • "cancellationDate": "2019-08-24T14:15:22Z",
  • "cancellationReason": "string",
  • "completionDate": "2019-08-24T14:15:22Z",
  • "href": "string",
  • "id": "string",
  • "orderDate": "2019-08-24T14:15:22Z",
  • "productOrderItem": [
    ],
  • "state": "acknowledged",
  • "stateChange": [
    ]
}
➔ Next to Product Inventory Management