Optimizely Punch Out Order Requests API
The Punch Out Order Requests API from Optimizely — 8 operation(s) for punch out order requests.
Operations 12
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
GET
/api/v1/admin/PunchOutOrderRequests
List punchout order requests · Returns the EntitySet PunchOutOrderRequests
#
Ask an LLM
“Which punchout purchase orders have come in from procurement systems?”
“Can I filter punchout order requests by status or customer PO?”
Tell an agent
List all punchout order requests.
Find punchout order requests matching {filter}.
POST
/api/v1/admin/PunchOutOrderRequests
Record a punchout order request · Post a new entity to EntitySet PunchOutOrderRequests
#
Ask an LLM
“How do I store an incoming cXML punchout order request in the commerce admin?”
“What billing and shipping fields does a new punchout order request need?”
Tell an agent
Record punchout order {orderId} with customer PO {customerPo} and cXML {punchOutOrderRequestCXml}.
Create a punchout order request for order {orderId} totalling {total} {totalCurrency}.
GET
/api/v1/admin/PunchOutOrderRequests({id})
Get a punchout order request · Returns the entity with the key from PunchOutOrderRequests
#
Ask an LLM
“What are the ship-to and bill-to details of one punchout order request?”
“Which requisition does a specific punchout order request belong to?”
Tell an agent
Get punchout order request {id}.
Show punchout order request {id} with {expand} expanded.
PUT
/api/v1/admin/PunchOutOrderRequests({id})
Replace a punchout order request · Replace entity in EntitySet PunchOutOrderRequests
#
Ask an LLM
“How do I overwrite a full punchout order request record?”
“Does replacing a punchout order request wipe fields I omit?”
Tell an agent
Replace punchout order request {id} with a full record for order {orderId}.
Overwrite punchout order request {id} with status {status} and customer PO {customerPo}.
DELETE
/api/v1/admin/PunchOutOrderRequests({id})
Delete a punchout order request · Delete entity in EntitySet PunchOutOrderRequests
#
Ask an LLM
“How do I remove one punchout order request by its ID?”
“Can a punchout order request delete be guarded by an ETag?”
Tell an agent destructive · confirm first
Delete punchout order request {id}.
Delete punchout order request {id} only if its ETag matches {etag}.
PATCH
/api/v1/admin/PunchOutOrderRequests({id})
Update a punchout order request · Update entity in EntitySet PunchOutOrderRequests
#
Ask an LLM
“Can I change just the status of a punchout order request?”
“How do I correct the ship-to email on a punchout order request?”
Tell an agent
Set the status of punchout order request {id} to {status}.
Change the ship-to email on punchout order request {id} to {shipToEmail}.
GET
/api/v1/admin/PunchOutOrderRequests/Default.Default()
Get a blank punchout order request template · Call operation Default
#
Ask an LLM
“What default values does a new punchout order request start with?”
“Is there an empty punchout order request template I can fetch?”
Tell an agent
Fetch the default punchout order request template.
Show default field values for a new punchout order request.
DELETE
/api/v1/admin/punchoutorderrequests/delete
Bulk delete punchout order requests · Punch out order requests delete route
#
Ask an LLM
“How do I delete many punchout order requests at once?”
“Can I purge a list of punchout order requests by ID in one call?”
Tell an agent destructive · confirm first
Bulk delete punchout order requests {ids}.
Remove these punchout order requests together: {ids}.
GET
/api/v1/admin/punchoutorderrequests({key})/customproperties({custompropertyKey})
Get a custom property on a punchout order · Punch out order requests get custom property by key and custompropertykey
#
Ask an LLM
“What value is stored in a custom property on a punchout order request?”
“Can I read one custom property from a punchout order request?”
Tell an agent
Get custom property {custompropertyKey} on punchout order request {key}.
Show punchout order request {key}'s custom property {custompropertyKey}.
GET
/api/v1/admin/punchoutorderrequests({key})/punchoutorderrequestextrinsics({punchoutorderrequestextrinsicKey})
Get an extrinsic value on a punchout order · Punch out order requests get punch out order request extrinsic by key and…
#
Ask an LLM
“Which extrinsic values did the buyer's procurement system send with a punchout order?”
“Can I read one cXML extrinsic entry attached to a punchout order request?”
Tell an agent
Get extrinsic {punchoutorderrequestextrinsicKey} on punchout order request {key}.
Show the cXML extrinsic {punchoutorderrequestextrinsicKey} sent with punchout order {key}.
GET
/api/v1/admin/punchoutorderrequests({key})/punchoutorderrequestitemouts({punchoutorderrequestitemoutKey})
Get a line item on a punchout order · Punch out order requests get punch out order request item out by key and…
#
Ask an LLM
“What was ordered on a specific line of a punchout order request?”
“Can I look up one ItemOut line from a punchout order?”
Tell an agent
Get item line {punchoutorderrequestitemoutKey} of punchout order request {key}.
Show ItemOut {punchoutorderrequestitemoutKey} on punchout order {key}.
GET
/api/v1/admin/punchoutorderrequests({key})/punchoutorderrequestmessages({punchoutorderrequestmessageKey})
Get a validation message on a punchout order · Punch out order requests get punch out order request message by key and…
#
Ask an LLM
“Why did a punchout order request fail validation?”
“Can I read one validation message attached to a specific punchout order?”
Tell an agent
Get validation message {punchoutorderrequestmessageKey} on punchout order request {key}.
Show message {punchoutorderrequestmessageKey} recorded against punchout order {key}.