UMG-UK
  1. Outbound Orders
UMG-UK
  • Outbound Orders
    • Get SalesOrder List
      GET
    • Create a SalesOrder
      POST
    • Get Sales Order Information
      GET
    • Sales Order Acknowledgement
      POST
    • Bulk Upload SalesOrders
      POST
    • Get Job Status of an Async Bulk Sales Order Import
      GET
    • Get a single SalesOrder
      GET
    • Update SalesOrder
      PUT
    • Cancel SalesOrder
      DELETE
    • Get Shipments for a Sales Order
      GET
    • Get B2B Customers For Business Unit
      GET
  • Ship Confirmation
    • Sales Order Ship Confirmation
      POST
  • Business Units
    • Get Buildings associated to a Business Unit
      GET
    • Remove associated Building from a Business Unit
      DELETE
    • Associate a Building to a Business Unit
      PUT
    • Get Business Unit Detail
      GET
    • Update Business Unit
      PUT
    • List Business Units
      GET
    • Create Business Unit
      POST
    • Get Business Unit General Settings
      GET
    • Update Business Unit General Settings
      PUT
    • Update Business Unit Amazon SFP Keys
      PUT
    • Remove Business Unit Amazon SFP Keys
      DELETE
    • Get Business Unit Amazon SFP Keys
      GET
    • List Broker Accounts
      GET
    • Create Broker Account
      POST
    • Delete Broker Account
      DELETE
  • Product
    • Batch Upload SKUs
    • Get Product Information
    • List SKUs
    • Create SKU
    • Get SKU Details
    • Update SKU Details
    • Update SKU Details
  • Inbound
    • List Inbound ASNs
    • Create Inbound ASN
    • Get single Inbound ASN
    • Update single Inbound ASN
    • Cancel single Inbound ASN
    • Get receipt lines for single Inbound ASN
    • Get receipt lines for single Inbound RMA
    • Get single Inbound RMA
    • Update single Inbound RMA
    • Cancel single Inbound RMA
    • List Inbound RMAs
    • Create Inbound RMA
    • Get receipt lines for single Inbound PO
    • Get single Inbound PO
    • Update single Inbound PO
    • Cancel single Inbound PO
    • List Inbound POs
    • Create Inbound PO
  • Inventory
    • List Inventory Transactions
    • List Inventory stats grouped by SKU
    • List Inventory stats grouped by Lot
    • List Inventory stats grouped by SKU and Building
    • List Inventory stats grouped by Lot and Building
    • List Inventory Serial Numbers
  • Inventory Movement
    • Inventory Movement
  • TMS Endpoints
    • Generate TMS Quotes for Sales Order
    • Book TMS Shipment for Sales Order
    • Delete Booked TMS Shipment For Sales Order
    • Update BOL for Order
    • Approve Quote for Order & Drop to WMS
    • Get ERP Token
  1. Outbound Orders

Get Sales Order Information

GET
/getSalesOrder/{company_no}/orders
Outbound Orders

Request

Path Params
company_no
string 
required
Query Params
limit
integer 
optional
This is the maximum number of objects that may be returned. A query may return fewer than the value of limit due to filtering.
Default:
100
customerOrderNumber
string 
optional
Filter to orders where customerOrderNumber begins with this string.

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/getSalesOrder//orders'

Responses

🟢200successful operation
application/json
Body
data
array [object {31}] 
optional
orderLines
array [object {10}] 
optional
customerOrderNumber
string 
optional
jobId
string 
optional
orderCreatedDate
string 
optional
requestedBuildingId
string 
optional
shipTo
object 
optional
notes
string 
optional
carrierId
string 
optional
shippingSpeed
string 
optional
deliveryInstructions1
string 
optional
deliveryInstructions2
string 
optional
buyerOrderNumber
string 
optional
fulfillFlag
boolean 
optional
fillKillIndicator
string 
optional
customerOrderType
string 
optional
billTo
object 
optional
giftMessage
string 
optional
orderAmount
number 
optional
isSignatureRequired
boolean 
optional
isInsuranceRequired
boolean 
optional
orderDropDate
string 
optional
customerDates
object 
optional
salesChannelOrderInfo
object 
optional
customerId
string 
optional
priority
string 
optional
shipServiceLevel
string 
optional
purchaseOrderNumber
string 
optional
accessorials
array [object {3}] 
optional
thirdPartyAccountNumber
string 
optional
useAccountFrom
string 
optional
brandId
string 
optional
Example
{
    "data": [
        {
            "orderLines": [
                {
                    "skuId": "string",
                    "quantity": 0,
                    "quantityMeasure": "string",
                    "customerLineNumber": "string",
                    "customerSku": "string",
                    "giftMessage": "string",
                    "notes": "string",
                    "lineType": "string",
                    "amount": 0,
                    "giftCardInfo": {
                        "amount": 0,
                        "code": "string",
                        "detail": "string",
                        "type": "string"
                    }
                }
            ],
            "customerOrderNumber": "string",
            "jobId": "string",
            "orderCreatedDate": "string",
            "requestedBuildingId": "string",
            "shipTo": {
                "name": "string",
                "address1": "string",
                "address2": "string",
                "address3": "string",
                "city": "string",
                "state": "string",
                "country": "string",
                "postalCode": "string",
                "email": "string",
                "phoneNumber": "string",
                "faxNumber": "string",
                "attentionTo": "string"
            },
            "notes": "string",
            "carrierId": "string",
            "shippingSpeed": "string",
            "deliveryInstructions1": "string",
            "deliveryInstructions2": "string",
            "buyerOrderNumber": "string",
            "fulfillFlag": true,
            "fillKillIndicator": "string",
            "customerOrderType": "string",
            "billTo": {
                "name": "string",
                "address1": "string",
                "address2": "string",
                "address3": "string",
                "city": "string",
                "state": "string",
                "country": "string",
                "postalCode": "string",
                "email": "string",
                "phoneNumber": "string",
                "faxNumber": "string",
                "attentionTo": "string"
            },
            "giftMessage": "string",
            "orderAmount": 0,
            "isSignatureRequired": true,
            "isInsuranceRequired": true,
            "orderDropDate": "string",
            "customerDates": {
                "requestedDeliveryDate": "string",
                "requestedShipDate": "string",
                "deliveryStartDate": "string",
                "deliveryEndDate": "string",
                "doNotShipBefore": "string",
                "doNotShipAfter": "string",
                "cancelAfter": "string",
                "cancelIfNotDeliveredBy": "string"
            },
            "salesChannelOrderInfo": {
                "salesChannelName": "string",
                "orderNumber": "string",
                "purchaseDate": "string",
                "lastUpdateDate": "string",
                "shipServiceLevel": "string",
                "earliestShipDate": "string",
                "latestShipDate": "string",
                "earliestDeliveryDate": "string",
                "latestDeliveryDate": "string"
            },
            "customerId": "string",
            "priority": "string",
            "shipServiceLevel": "string",
            "purchaseOrderNumber": "string",
            "accessorials": [
                {
                    "code": "string",
                    "accessorialType": "string",
                    "parameters": [
                        {
                            "name": "string",
                            "value": "string"
                        }
                    ]
                }
            ],
            "thirdPartyAccountNumber": "string",
            "useAccountFrom": "string",
            "brandId": "string"
        }
    ]
}
🟢202Get Sales Order Successful
🟠400Get Sales Order failed
🟠401Authentication Failed
🔴500Error in Server
Modified at 2024-07-02 10:16:06
Previous
Create a SalesOrder
Next
Sales Order Acknowledgement
Built with