> For the complete documentation index, see [llms.txt](https://sandbox-docs.verifone.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://sandbox-docs.verifone.com/global-partners/global-partners-api-integration/global-partners-integration/create-orders.md).
# Create Orders
* Partner to call VF endpoint, passing order data (JSON) and load into Oracle.
* Response sent back to partner synchronously, using provided JSON response format.
## Sales order create API
> Create a new sales order in Oracle, but it does not update the order.
```json
{"openapi":"3.1.1","info":{"title":"ORDS generated API for Partners","version":"1.0.1"},"servers":[{"url":"https://uat.justransform.com/justransform/restrouter/receive/partners/hwdev","description":"UAT Server"}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"Use username: partnertest and password: partnertest"}},"schemas":{"CreateOrderRequest":{"type":"object","required":["orders"],"properties":{"orders":{"type":"array","description":"API spec fileds","items":{"$ref":"#/components/schemas/CreateOrder"}}}},"CreateOrder":{"type":"object","required":["customerEntityUid","additionalOrderData","billingAddress","shippingAddress","additionalPackageData","Lines"],"properties":{"customerEntityUid":{"type":"string","description":"Partner Customer Number (Oracle Customer Number assigned by Verifone to partners)"},"additionalOrderData":{"type":"object","description":"Verifone Selling Entity information","properties":{"variableName":{"type":"string","description":"Default to \"vfOperatingUnit\""},"variableValue":{"type":"string","description":"Verifone Selling Entity (ex. USA=\"INC\", UK=\"LHR\")"}}},"billingAddress":{"type":"object","description":"Billing customer information","properties":{"contactType":{"type":"string","description":"Null if Billed to originating Partner, Fill in otherwise"},"firstName":{"type":"string","description":"Null if Billed to originating Partner, Fill in otherwise"},"lastName":{"type":"string","description":"Null if Billed to originating Partner, Fill in otherwise"},"prefix":{"type":"string","description":"Null if Billed to originating Partner, Fill in otherwise"},"suffix":{"type":"string","description":"Null if Billed to originating Partner, Fill in otherwise"},"callingCode":{"type":"string","description":"Null if Billed to originating Partner, Fill in otherwise"},"value":{"type":"string","description":"Null if Billed to originating Partner, Fill in otherwise"},"extension":{"type":"string","description":"Null if Billed to originating Partner, Fill in otherwise"},"isPrimary":{"type":"string","description":"Null if Billed to originating Partner, Fill in otherwise"},"phoneType":{"type":"string","description":"Null if Billed to originating Partner, Fill in otherwise"},"email":{"type":"string","description":"Null if Billed to originating Partner, Fill in otherwise"},"businessTitle":{"type":"string","description":"Null if Billed to originating Partner, Fill in otherwise"},"storeNumber":{"type":"string","description":"Null - future use"},"receiverName":{"type":"string","description":"Null if Billed to originating Partner, Fill in otherwise"},"vfiSiteId":{"type":"string","description":"If available, rest of Bill-to fields can be NULL, Fill otherwise"},"addressLine1":{"type":"string","description":"Null if Billed to originating Partner, Fill in otherwise"},"addressLine2":{"type":"string","description":"Null if Billed to originating Partner, Fill in otherwise"},"addressLine3":{"type":"string","description":"Null if Billed to originating Partner, Fill in otherwise"},"city":{"type":"string","description":"Null if Billed to originating Partner, Fill in otherwise"},"state":{"type":"string","description":"Null if Billed to originating Partner, Fill in otherwise"},"postCode":{"type":"string","description":"Null if Billed to originating Partner, Fill in otherwise"},"country":{"type":"string","description":"Null if Billed to originating Partner, Fill in otherwise"}}},"shippingAddress":{"type":"object","description":"Shipping customer information","properties":{"contactType":{"type":"string","description":"Null if Partner has Single Ship-to Site, fill in otherwise"},"firstName":{"type":"string","description":"Null if Partner has Single Ship-to Site, fill in otherwise"},"lastName":{"type":"string","description":"Null if Partner has Single Ship-to Site, fill in otherwise"},"prefix":{"type":"string","description":"Null if Partner has Single Ship-to Site, fill in otherwise"},"suffix":{"type":"string","description":"Null if Partner has Single Ship-to Site, fill in otherwise"},"callingCode":{"type":"string","description":"Null if Partner has Single Ship-to Site, fill in otherwise"},"value":{"type":"string","description":"Null if Partner has Single Ship-to Site, fill in otherwise"},"extension":{"type":"string","description":"Null if Partner has Single Ship-to Site, fill in otherwise"},"isPrimary":{"type":"string","description":"Null if Partner has Single Ship-to Site, fill in otherwise"},"phoneType":{"type":"string","description":"Null if Partner has Single Ship-to Site, fill in otherwise"},"email":{"type":"string","description":"Null if Partner has Single Ship-to Site, fill in otherwise"},"businessTitle":{"type":"string","description":"Null if Partner has Single Ship-to Site, fill in otherwise"},"storeNumber":{"type":"string","description":"Null - future use"},"receiverName":{"type":"string","description":"Null if Partner has Single Ship-to Site, fill in otherwise"},"vfiSiteId":{"type":"string","description":"If available, rest of Ship-to fields can be NULL, Fill otherwise"},"addressLine1":{"type":"string","description":"Null if Partner has Single Ship-to Site, fill in otherwise"},"addressLine2":{"type":"string","description":"Null if Partner has Single Ship-to Site, fill in otherwise"},"addressLine3":{"type":"string","description":"Null if Partner has Single Ship-to Site, fill in otherwise"},"city":{"type":"string","description":"Null if Partner has Single Ship-to Site, fill in otherwise"},"state":{"type":"string","description":"Null if Partner has Single Ship-to Site, fill in otherwise"},"postCode":{"type":"string","description":"Null if Partner has Single Ship-to Site, fill in otherwise"},"country":{"type":"string","description":"Null if Partner has Single Ship-to Site, fill in otherwise"}}},"poRef":{"type":"string","description":"Customer PO Number"},"orderReference":{"type":"string","description":"Null - future use"},"currency":{"type":"string","description":"Currency Code"},"orderedDate":{"type":"string","description":"Null if to default to Sysdate, fill in otherwise (MMDDYYYY)"},"shipmentOption":{"type":"string","description":"shipment option"},"shippingInstructions":{"type":"string","description":"Shipping Instructions"},"notes":{"type":"string","description":"Packing Instructions"},"additionalPackageData":{"type":"array","description":"Additional order details","items":{"type":"object","properties":{"variableName":{"type":"string","description":"Variable name (e.g. \"P2PEOrder\", \"P2PEEmail\")"},"variableValue":{"type":"string","description":"Variable value (e.g. P2PE flag \"Y\"/\"N\", P2PE email address if flag is Y)"}}}},"Lines":{"type":"object","description":"Order line information","properties":{"packageBundleId":{"type":"string","description":"Product Configuration"},"quantity":{"type":"string","description":"Quantity"},"requestedDate":{"type":"string","description":"Request Date"},"type":{"type":"string","description":"Transaction Type. \"Purchase\", \"Service\", \"Field Service\""},"serviceTerm":{"type":"string","description":"Service Term, needed only for Service Order"},"billingFrequency":{"type":"string","description":"BIlling Frequency, needed only for Service Order"},"serviceStartDate":{"type":"string","description":"Service Start Date, needed only for Service Order"},"softwareVersion":{"type":"string","description":"Software version number"}}}}},"ErrorResponse":{"type":"object","properties":{"code":{"type":"integer","description":"HTTP status code"},"message":{"type":"string","description":"Error message"},"details":{"type":"object","description":"Error details"},"timestamp":{"type":"integer","description":"Epoch timestamp"}}}}},"paths":{"/CreateOrder":{"post":{"summary":"Sales order create API","description":"Create a new sales order in Oracle, but it does not update the order.","operationId":"createOrder","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrderRequest"}}}},"responses":{"201":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrderResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"504":{"description":"Gateway Time-out","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://sandbox-docs.verifone.com/global-partners/global-partners-api-integration/global-partners-integration/create-orders.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.