Fulfillment Request
A fulfillment request record exposes a fulfillment request to REST web services.
A fulfillment request is created by doing a transformation on a sales order.
The status of fulfillment request can be changed. The fulfillment request exception can be added.
This record:
-
is not a subrecord
-
has the following subrecords:
-
FulfillmentRequestException
-
FulfillmentRequestIitem
-
FulfillmentRequestItemDetail
-
FufillmentRequestItemDetailInventoryAssignment
-
FulfillmentRequestItemException
-
The REST API Browser includes information about the field names and field types of the fulfillment request record, and about the HTTP methods, request parameters, and operations available to this record. For details, see the REST API Browser’s fulfillment request reference page.
For information about using the REST API Browser, see The REST API Browser.
Record ID
The record ID for a fulfillment request REST record is fulfillmentrequest.
Prerequisites
You must enable Fulfillment Request before you can use this record through REST web services.
Optionally, you must enable Store Pickup to use store pickup on the fulfillment request record through REST web services.
Elements Not Accessible Through REST Web Services
The following subtabs are not accessible using REST web services:
-
deletionreason
-
transactionnumber
-
lastmodifiedby
-
createdby
Code Sample
This sample shows how to transform a sales order to a fulfillment request:
POST -> {{COMPANY_URL}}/services/rest /record/v1/salesOrder/989?transform/fulfillmentRequest
With body: { "items": { "items": [ { "orderLine": 1, "quantity": 1 } ] }
}
Update transaction status to "In progress":
PATCH -> {{COMPANY_URL}}/services/rest/record/v1/fulfillmentrequest/992
Body: {
"tranStatus": { "id": "B" }
}