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 a single SalesOrder

GET
/business_units/{businessUnitId}/sales_orders/{customerOrderNumber}
Outbound Orders
We need to clarify what Id we will be passing as the customerOrderNumber. Is it the CustomerOrderNumber, or a Softeon generated Id?

Request

Path Params
businessUnitId
string 
required
customerOrderNumber
string 
required

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 '/business_units//sales_orders/'

Responses

🟢200OK
application/json
Body
data
object (SalesOrderDetail) 
optional
The current state and details of a SalesOrder
statusHistory
array [object {3}] 
required
Overall sales order status derived by Softeon. An example status of a split sales order may be "Partially Fulfilled."
totalContainers
integer 
required
This will be the total number of containers (AKA packages, tracking numbers) across all shipments for this order.
Default:
0
customerOrderNumber
string 
required
orderCreatedDate
string <date-time>
required
The orderCreatedDate used to drive SLAs
shipTo
object (Party) 
required
distributionOrderLines
array [object {16}] 
optional
shipServiceLevel
enum<string> 
optional
'extra level of specificity for shipping. Mandatory for LTL and must specify "G"'
G - LTL ground
01 - UPS Next Day air
02 - UPS 2nd Day air
03 - UPS ground
11 - UPS Standard
12 - UPS 3 Day Select
13 - UPS Next Day Air Saver
14 - UPS Next Day Air (noon)
65 - UPS Saver
93 - SurePost
<= 30 characters
Allowed values:
G010203111213146593
shippingSpeed
enum<string> 
optional
Allowed values:
1D2D5A5D
domsCreatedTimestamp
string <date-time>
optional
Timestamp for when this order was received and persisted by DOMS. Is this redundant to the first value in statusHistory?
customerId
string 
optional
customerOrderType
string 
optional
thirdPartyAccountNumber
string 
optional
Use this carrier billing account number for shipping. If this value is set, then any value in useAccountFrom will be ignored.
useAccountFrom
enum<string> 
optional
Use the specified stored carrier billing account number for shipping.
B - Business Unit (default)
C - Customer (requires customerId to be set)
Allowed values:
CB
Example
{
    "data": {
        "statusHistory": [
            {
                "status": "string",
                "timestamp": "2019-08-24T14:15:22Z",
                "user": "string"
            }
        ],
        "totalContainers": 0,
        "customerOrderNumber": "string",
        "orderCreatedDate": "2019-08-24T14:15:22Z",
        "shipTo": {
            "name": "string",
            "address1": "string",
            "address2": "string",
            "address3": "string",
            "city": "string",
            "state": "strin",
            "country": "strin",
            "postalCode": "string",
            "email": "foo@bar.com,fish@sea.net",
            "phoneNumber": "string",
            "faxNumber": "string",
            "attentionTo": "string"
        },
        "distributionOrderLines": [
            {
                "sku": {
                    "skuId": "string",
                    "name": "255",
                    "description1": "string",
                    "description2": "string"
                },
                "lineNumber": 0,
                "quantity": 0,
                "quantityMeasure": "EA",
                "status": "string",
                "allocatedQuantity": 0,
                "backOrderQuantity": 0,
                "cancelledQuantity": 0,
                "shippedQuantity": 0,
                "authQuantity": 0,
                "allocationStatus": "string",
                "cancelledReason": "string",
                "customerLineNumber": "string",
                "building": {
                    "buildingId": "strin",
                    "shortName": "string",
                    "name": "string"
                },
                "customerSku": "string",
                "distributionOrderNumber": "string"
            }
        ],
        "shipServiceLevel": "G",
        "shippingSpeed": "1D",
        "domsCreatedTimestamp": "2019-08-24T14:15:22Z",
        "customerId": "string",
        "customerOrderType": "string",
        "thirdPartyAccountNumber": "string",
        "useAccountFrom": "C"
    }
}
🟠404Not Found - Business Unit not found - SalesOrder not found
🔴500Internal Server Error
Modified at 2024-07-02 10:16:06
Previous
Get Job Status of an Async Bulk Sales Order Import
Next
Update SalesOrder
Built with