BackPreOrder service OpenAPI specification (2.0.0)

Download OpenAPI specification:Download

Fabric V2 BackPreOrder Apis For MultiTenant Service

BackOrderPreOrderReservation Controller

These Endpoints help in performing BackOrderPreOrderReservation creation and updating operations

Update BackOrderPreOrderReservation

SecurityAuthorization or context
Request
path Parameters
lineItemId
required
string
orderNumber
required
string
Request Body schema: application/json
string
Responses
200

BackOrderPreOrderReservation object Updated

400

Bad Request

404

Object Not Found!

500

Internal Server Error

put/backorderpreorder-reserve/{lineItemId}/{orderNumber}
Request samples
application/json
{
  • "backOrderedQuantity": 2,
  • "toReleaseQuantity": 3,
  • "locationNum": 23,
  • "channelId": "channel_12",
  • "vendorId": "vendor_123",
  • "consentToDelay": "true",
  • "consentDate": "2022-07-12T09:30:31.198Z",
  • "lastNotificationDate": "2022-06-12T09:30:31.198Z",
  • "toNotify": "false",
  • "orderStatusCode": "Created",
  • "lineItemStatus": "CANCELLED",
  • "paymentStatus": "OK"
}
Response samples
application/json
{
  • "id": "1",
  • "orderNumber": "order_123",
  • "sku": "sku_123",
  • "lineItemId": "0",
  • "itemId": "123",
  • "type": "BACKORDER",
  • "cartId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",
  • "orderDate": "2022-04-12T09:30:31.198Z",
  • "backOrderedQuantity": 5,
  • "toReleaseQuantity": 0,
  • "locationNum": 23,
  • "channelId": "channel_12",
  • "vendorId": "vendor_123",
  • "consentToDelay": "true",
  • "consentDate": "2022-07-12T09:30:31.198Z",
  • "lastNotificationDate": "2022-06-12T09:30:31.198Z",
  • "toNotify": "false",
  • "orderStatusCode": "Created",
  • "lineItemStatus": "CANCELLED",
  • "paymentStatus": "OK"
}

Get backOrderPreOrderReservation

SecurityAuthorization or context
Request
query Parameters
BackOrderPreOrderReservationId
string
Responses
200

backOrderPreOrderReservation returned

400

Bad Request

404

Object Not Found!

500

Internal Server Error

get/backorderpreorder-reserve
Response samples
application/json
{
  • "id": "1",
  • "orderNumber": "order_123",
  • "sku": "sku_123",
  • "lineItemId": "0",
  • "itemId": "123",
  • "type": "BACKORDER",
  • "cartId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",
  • "orderDate": "2022-04-12T09:30:31.198Z",
  • "backOrderedQuantity": 5,
  • "toReleaseQuantity": 0,
  • "locationNum": 23,
  • "channelId": "channel_12",
  • "vendorId": "vendor_123",
  • "consentToDelay": "true",
  • "consentDate": "2022-07-12T09:30:31.198Z",
  • "lastNotificationDate": "2022-06-12T09:30:31.198Z",
  • "toNotify": "false",
  • "orderStatusCode": "Created",
  • "lineItemStatus": "CANCELLED",
  • "paymentStatus": "OK"
}

Create backOrderPreOrderReservation

SecurityAuthorization or context
Request
Request Body schema: application/json
id
string
orderNumber
required
string
sku
required
string
lineItemId
required
string
itemId
string
type
required
string
cartId
string
orderDate
required
string <date-time>
backOrderedQuantity
required
integer <int32>
toReleaseQuantity
integer <int32>
locationNum
required
integer <int32>
channelId
required
string
vendorId
string
consentToDelay
string
consentDate
string <date-time>
lastNotificationDate
string <date-time>
toNotify
string
orderStatusCode
required
string
lineItemStatus
string
paymentStatus
string
Responses
200

backOrderPreOrderReservation Created

400

Bad Request

404

BackOrderPreOrderReservation Not Found

500

Internal Server Error

post/backorderpreorder-reserve
Request samples
application/json
{
  • "id": "1",
  • "orderNumber": "order_123",
  • "sku": "sku_123",
  • "lineItemId": "0",
  • "itemId": "123",
  • "type": "BACKORDER",
  • "cartId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",
  • "orderDate": "2022-04-12T09:30:31.198Z",
  • "backOrderedQuantity": 5,
  • "toReleaseQuantity": 0,
  • "locationNum": 23,
  • "channelId": "channel_12",
  • "vendorId": "vendor_123",
  • "consentToDelay": "true",
  • "consentDate": "2022-07-12T09:30:31.198Z",
  • "lastNotificationDate": "2022-06-12T09:30:31.198Z",
  • "toNotify": "false",
  • "orderStatusCode": "Created",
  • "lineItemStatus": "CANCELLED",
  • "paymentStatus": "OK"
}
Response samples
application/json
{
  • "id": "1",
  • "orderNumber": "order_123",
  • "sku": "sku_123",
  • "lineItemId": "0",
  • "itemId": "123",
  • "type": "BACKORDER",
  • "cartId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",
  • "orderDate": "2022-04-12T09:30:31.198Z",
  • "backOrderedQuantity": 5,
  • "toReleaseQuantity": 0,
  • "locationNum": 23,
  • "channelId": "channel_12",
  • "vendorId": "vendor_123",
  • "consentToDelay": "true",
  • "consentDate": "2022-07-12T09:30:31.198Z",
  • "lastNotificationDate": "2022-06-12T09:30:31.198Z",
  • "toNotify": "false",
  • "orderStatusCode": "Created",
  • "lineItemStatus": "CANCELLED",
  • "paymentStatus": "OK"
}

Get backOrderPreOrderReservation list

SecurityAuthorization or context
Request
path Parameters
identifier
required
string

orderNumber

Responses
200

backOrderPreOrderReservation list returned

400

Bad Request

404

Object Not Found!

500

Internal Server Error

get/backorderpreorder-reserve/{identifier}
Response samples
application/json
[
  • {
    }
]

Delete BackOrderPreOrderReservation

SecurityAuthorization or context
Request
path Parameters
identifier
required
string

backPreorderId

Responses
200

BackOrderPreOrderReservation object deleted

400

Bad Request

404

Object Not Found!

500

Internal Server Error

delete/backorderpreorder-reserve/{identifier}
Response samples
application/json
{
  • "id": "1",
  • "orderNumber": "order_123",
  • "sku": "sku_123",
  • "lineItemId": "0",
  • "itemId": "123",
  • "type": "BACKORDER",
  • "cartId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",
  • "orderDate": "2022-04-12T09:30:31.198Z",
  • "backOrderedQuantity": 5,
  • "toReleaseQuantity": 0,
  • "locationNum": 23,
  • "channelId": "channel_12",
  • "vendorId": "vendor_123",
  • "consentToDelay": "true",
  • "consentDate": "2022-07-12T09:30:31.198Z",
  • "lastNotificationDate": "2022-06-12T09:30:31.198Z",
  • "toNotify": "false",
  • "orderStatusCode": "Created",
  • "lineItemStatus": "CANCELLED",
  • "paymentStatus": "OK"
}

BackOrderPreOrderAck Controller

These Endpoints help in performing BackOrderPreOrder consent to delay operations

To handle user response on consent of delay.

SecurityAuthorization or context
Request
Request Body schema: application/json
backOrderId
required
string
action
required
string
Responses
200

backOrderPreOrderAck ping

400

Bad Request

404

Object Not Found!

500

Internal Server Error

post/order/backorder/consent-to-delay
Request samples
application/json
{
  • "backOrderId": "1",
  • "action": "accept"
}
Response samples
application/json
{
  • "id": "1",
  • "orderNumber": "order_123",
  • "sku": "sku_123",
  • "lineItemId": "0",
  • "itemId": "123",
  • "type": "BACKORDER",
  • "cartId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",
  • "orderDate": "2022-04-12T09:30:31.198Z",
  • "backOrderedQuantity": 5,
  • "toReleaseQuantity": 0,
  • "locationNum": 23,
  • "channelId": "channel_12",
  • "vendorId": "vendor_123",
  • "consentToDelay": "true",
  • "consentDate": "2022-07-12T09:30:31.198Z",
  • "lastNotificationDate": "2022-06-12T09:30:31.198Z",
  • "toNotify": "false",
  • "orderStatusCode": "Created",
  • "lineItemStatus": "CANCELLED",
  • "paymentStatus": "OK"
}

BackOrderPreOrderUpdating Controller

These Endpoints help in performing BackOrderPreOrder Updating operations

called when outer service updated any order has back/pre items, Allocation service after release

SecurityAuthorization or context
Request
Request Body schema: application/json
string
Responses
200

BackOrderPreOrder service will get back/pre items from order models

400

Bad Request

404

Object Not Found!

500

Internal Server Error

post/backorderpreorder-update
Request samples
application/json
{
  • "orderNumbers": [
    ]
}
Response samples
application/json
{ }