
We can update and Order EFF or DFF using the provided Rest Apis. The order should be in a state of update.
Also with this API an Order can be revised.
Table of Contents
How to Create an Order with Fulfillment Line and Header EFF information Using the – salesOrdersForOrderHub – REST API
The Rest API URL is
Query an order
https://yourfusiondomain/fscmRestApi/resources/11.13.18.05/salesOrdersForOrderHub?q=OrderNumber=97416; StatusCode='DOO_DRAFT'

Get order key from response payload
Query Order Line using order key as URL parameter
https://yourfusiondomain/fscmRestApi/resources/11.13.18.05/salesOrdersForOrderHub/OPS:300000246218001/child/lines
And get fulfillment line Id from response payload. Here we are picking line 3

Search for additionalinformation in the response payload and you will find links url as below

Use the Get operation to query additional EFF information
https://yourdomain.com:443/fscmRestApi/resources/11.13.18.05/salesOrdersForOrderHub/OPS%3A300000246218001/child/lines/00020000000EACED0005770800005AF33D6321650000000EACED0005770800005AF33D632161/child/additionalInformation

Get the EFF name from the Response above and the link url for EFF
https://yourdomain.com/fscmRestApi/resources/11.13.18.05/salesOrdersForOrderHub/OPS%3A300000246218001/child/lines/00020000000EACED0005770800005AF33D6321650000000EACED0005770800005AF33D632161/child/additionalInformation/100000753459557/child/FulfillLineEffBPricingLineInformationprivateVO

Use the PATCH operation to update the EFF

https://yourdomain.com/fscmRestApi/resources/11.13.18.05/salesOrdersForOrderHub/OPS:300000246218001
Payload for EFF update on sales order
{
"lines": [
{
"FulfillLineId": 100000753459557,
"additionalInformation": [
{
"Category": "DOO_FULFILL_LINES_ADD_INFO",
"FulfillLineEffBPricingLineInformationprivateVO": [
{
"ContextCode": "Pricing Line Information",
"Weight": "40",
"EffLineId": 300000246220724
}
]
}
]
}
]
Create Order with Header EFF and Fulfillment Line EFF sample Payload
Create Order with Header EFF and Fulfillment Line EFF sample Payload
{
"SourceTransactionNumber": "PMC-REST-20191122-002",
"SourceTransactionSystem": "OPS",
"SourceTransactionId": "PMC-REST-20191122-002",
"TransactionalCurrencyName": "US Dollar",
"BusinessUnitName": "FUSION COLORADO SPRINGS",
"BuyingPartyName": "PMC - Snow Enterprise",
"TransactionOn": "2019-11-18T19:51:48+00:00",
"SubmittedFlag": true,
"FreezePriceFlag": false,
"FreezeShippingChargeFlag": false,
"FreezeTaxFlag": false,
"RequestingBusinessUnitName": "FUSION COLORADO SPRINGS",
"billToCustomer": [
{
"PartyName": "PMC - Snow Enterprise",
"AccountNumber": "3",
"SiteUseId": 300000001703008
}
],
"shipToCustomer": [
{
"PartyName": "PMC - Snow Enterprise",
"SiteId": 300000001703006
}
],
"additionalInformation": [
{
"Category": "DOO_HEADERS_ADD_INFO",
"HeaderEffBPMC__HeaderprivateVO": [
{
"ContextCode": "PMC Header",
"customerBillToId": "10810"
}
]
}
],
"lines": [
{
"SourceTransactionLineId": "1",
"SourceTransactionLineNumber": "1",
"SourceScheduleNumber": "1",
"SourceTransactionScheduleId": "1",
"OrderedUOMCode": "Ea",
"OrderedQuantity": 1,
"ProductNumber": "PMC - Std Item",
"FreightTerms": "Add freight",
"PaymentTerms": "30 Net",
"ShipmentPriority": "High",
"RequestedShipDate": "2019-11-18T19:51:48+00:00",
"RequestedFulfillmentOrganizationName": "Fusion Denver",
"billToCustomer": [
{
"PartyName": "PMC - Snow Enterprise",
"AccountNumber": "3",
"SiteUseId": 300000001703008
}
],
"shipToCustomer": [
{
"PartyName": "PMC - Snow Enterprise",
"SiteId": 300000001703006
}
],
"additionalInformation": [
{
"Category": "DOO_FULFILL_LINES_ADD_INFO",
"FulfillLineEffBSourceLineInfoprivateVO": [
{
"ContextCode": "SourceLineInfo",
"status": "hellsbells"
}
]
}
]
}
]
}
Order fulfillment line EFF Sample Payload
“additionalInformation”: [
{
“Category”: “DOO_FULFILL_LINES_ADD_INFO”,
“FulfillLineEffBSourceLineInfoprivateVO”: [
{
“ContextCode”: “SourceLineInfo”,
“status”: “hellsbells”
}
]
}
]
Payload for Header EFF
"additionalInformation": [
{
"Category": "DOO_HEADERS_ADD_INFO",
"HeaderEffBPMC__HeaderprivateVO": [
{
"ContextCode": "PMC Header",
"customerBillToId": "10810"
}
]
}
]
Ref : FA: SCM: Master Note – Using REST APIs (Doc ID 2615066.1) |