The Traverse Systems Vision API is a great tool to power your internal tools or transfer data to Traverse Systems. Our API uses the REST architecture and follows the OpenAPI specifications. Our API returns JSON-encoded responses and uses standard HTTP response codes and verbs. HTTPS is required for our API.
Additional Resources:
The goal of The OpenAPI Specification is to define a standard, language-agnostic interface to REST APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection. When properly defined via OpenAPI, a consumer can understand and interact with the remote service with a minimal amount of implementation logic. Similar to what interfaces have done for lower-level programming, OpenAPI removes the guesswork in calling the service.
Available authentication methods for Vision:
The goal of The OpenAPI Specification is to define a standard, language-agnostic interface to REST APIs which
The Traverse Systems Vision ASN API allows Vision customers to send an Advanced Ship Notice (ASN) to Vision. Once in Vision, recipients can view the ASN and ensure they are prepared to receive the Shipment. The ASN includes information such as the number of cartons, the number of units, the origin zip code, vendor number, and more.
This API endpoint receives JSON data representing an Advanced Ship Notice.
Access to this endpoint may differ based on user permissions.
The request body should contain JSON data representing an ASN.
PoNum | string |
SequenceNum | string |
VendorNum | string or null |
ReceivedDate | date-time or null |
BolNum | string or null |
FreightBillNum | string or null |
Scac | string or null |
DestinationLocNum | string or null |
PickupDate | date-time or null |
CartonCount | string or null |
OriginZip | string or null |
TotalUnits | string or null |
DropLoc | string or null |
Division | string or null |
ExpectedDeliveryDate | date-time or null |
PoUniqueAddenda | string or null |
AuthorizationNum | string or null |
Array of objects or null (AsnCarton) A list of ASN Cartons |
An Example ASN.
{- "PoNum": "2558455JR",
- "SequenceNum": "30PXWZ71120220920_JR",
- "VendorNum": "00004919486",
- "ReceivedDate": "2022-09-20T00:00:00",
- "BolNum": null,
- "FreightBillNum": "608565129938",
- "Scac": "RPSI",
- "DestinationLocNum": "01100",
- "PickupDate": "2022-09-20T00:00:00",
- "CartonCount": 1,
- "OriginZip": "761550000",
- "TotalUnits": 0,
- "DropLoc": null,
- "Division": null,
- "ExpectedDeliveryDate": "2022-09-20T00:00:00",
- "PoUniqueAddenda": "20220912",
- "AuthorizationNum": null,
- "Cartons": [
- {
- "Gs1128": "00006629190705653906",
- "StoreNum": "01100",
- "TrackingNum": null,
- "CartonDetails": [
- {
- "Sku": "019019800169610000000",
- "Upc": "00190198001696",
- "Qty": 2,
- "Cost": 15.16,
- "Retail": 29.99,
- "Um": null,
- "PackSize": 1,
- "LotNum": null,
- "LotUm": null,
- "LotExpireDate": null,
- "LotManufactureDate": null
}, - {
- "Sku": "019019909842810000000",
- "Upc": "00190199098428",
- "Qty": 1,
- "Cost": 117.32,
- "Retail": 127.99,
- "Um": null,
- "PackSize": 1,
- "LotNum": null,
- "LotUm": null,
- "LotExpireDate": null,
- "LotManufactureDate": null
}, - {
- "Sku": "019019971066510000000",
- "Upc": "00190199710665",
- "Qty": 1,
- "Cost": 89,
- "Retail": 97.99,
- "Um": null,
- "PackSize": 1,
- "LotNum": null,
- "LotUm": null,
- "LotExpireDate": null,
- "LotManufactureDate": null
}, - {
- "Sku": "019425222055910000000",
- "Upc": "00194252220559",
- "Qty": 1,
- "Cost": 136.8,
- "Retail": 147.99,
- "Um": null,
- "PackSize": 1,
- "LotNum": null,
- "LotUm": null,
- "LotExpireDate": null,
- "LotManufactureDate": null
}, - {
- "Sku": "088590962730110000000",
- "Upc": "00885909627301",
- "Qty": 2,
- "Cost": 15.16,
- "Retail": 19.99,
- "Um": null,
- "PackSize": 1,
- "LotNum": null,
- "LotUm": null,
- "LotExpireDate": null,
- "LotManufactureDate": null
}
]
}
]
}
"Success"
The Traverse Systems Vision Department API allows Vision customers to send a Department to Vision. The Department can include a number, a sub department number, a description, a class, and groups.
This API endpoint receives JSON data representing a Department and any Department Groups associated to the Department.
Access to this endpoint may differ based on user permissions.
The request body should contain JSON data representing a Department.
DeptNum | string |
Description | string or null |
SubDeptNum | string or null |
Class | string or null |
Array of objects or null (DeptGroup) A list of Dept Groups |
An Example Department.
{- "DeptNum": "0994t1",
- "Description": "W BRANDED SWIM",
- "SubDeptNum": null,
- "Class": null,
- "Groups": [
- {
- "Name": "Test Group",
- "Description": "Test Group Description"
}
]
}
"Success"
The Traverse Systems Vision Ocean Status API allows Vision customers to send a Container Status to Vision. The ability to view the Ocean Container Status in Vision keeps retailers up to date on the location of their goods and allows for informed logistics decisions.
This API endpoint receives data file containing information about Ocean Containers and their status information. Datafile layout is determined during implementation.
Access to this endpoint may differ based on user permissions.
The request body should contain JSON data representing a Ocean Container File.
null
"Success"
The Traverse Systems Vision PO API allows Vision customers to send a Purchase Order to Vision. The Purchase Order is the ultimate source of truth, documenting what was ordered, when, and by whom, along with numerous other optional fields.
This API endpoint receives JSON data representing a Purchase Order including all of it's Item and Store information.
Access to this endpoint may differ based on user permissions.
The request body should contain JSON data representing an PO.
PoNum | string |
UniqueAddenda | string |
MasterPoNum | string or null |
DeptNum | string or null |
VendorNum | string |
ShipStartDate | date-time or null |
ShipStopDate | date-time or null |
PoCreateDate | date-time or null |
PoApprovalDate | date-time or null |
PoCancelDate | string or null |
OtbDate | string or null |
XrefPoNum | string or null |
OrderType | string or null |
PackByStore | string or null |
EdiSentDate | date-time or null |
NewStoreFlag | string or null |
AdvertisedDate | date-time or null |
Fob | string or null |
ShipToNum | string or null |
OrderStatus | string or null |
DistMethod | string or null |
BillType | string or null |
ReplenishmentFlag | string or null |
SpecialOrderInd | string or null |
TotalUnits | number or null |
MerchantNum | string or null |
MerchantName | string or null |
AdEvent | string or null |
SecondAdEvent | string or null |
Terms | string or null |
PoReleaseDate | date-time or null |
ParentCompany | string or null |
Factory | string or null |
PoTotalCost | number or null |
Version | string or null |
DeliveryPointType | string or null |
NewStorePct | string or null |
PreTicketFlag | string or null |
PoComments | string or null |
UserDef1 | string or null |
UserDef2 | string or null |
UserDef3 | string or null |
Array of objects or null (PoItem) A list of PO Items |
An Example PO.
{- "PoNum": "2558455JR",
- "UniqueAddenda": "20220912",
- "MasterPoNum": null,
- "DeptNum": "0815",
- "VendorNum": "00004919486",
- "ShipStartDate": "2022-09-17T00:00:00",
- "ShipStopDate": "2022-11-14T00:00:00",
- "PoCreateDate": "2022-09-16T00:00:00",
- "PoApprovalDate": "2022-09-17T00:00:00",
- "PoCancelDate": null,
- "OtbDate": null,
- "XrefPoNum": null,
- "OrderType": "ENTRY",
- "PackByStore": "N",
- "EdiSentDate": "2022-09-16T00:00:00",
- "NewStoreFlag": "N",
- "AdvertisedDate": null,
- "Fob": null,
- "ShipToNum": "16101",
- "OrderStatus": "N",
- "DistMethod": "BULK",
- "BillType": "Destination/Prepaid",
- "ReplenishmentFlag": null,
- "SpecialOrderInd": null,
- "TotalUnits": 10,
- "MerchantNum": "123465",
- "MerchantName": "Bob Smith",
- "AdEvent": "2022-11",
- "SecondAdEvent": null,
- "Terms": "NET 30",
- "PoReleaseDate": null,
- "ParentCompany": null,
- "Factory": null,
- "PoTotalCost": null,
- "Version": null,
- "DeliveryPointType": null,
- "NewStorePct": null,
- "PreTicketFlag": null,
- "PoComments": null,
- "UserDef1": null,
- "UserDef2": null,
- "UserDef3": null,
- "Items": [
- {
- "Sku": "019019931290610000000",
- "Upc": "00190199312906",
- "LineNum": 1,
- "ItemCost": 0,
- "ItemRetail": 0,
- "InnerPackQty": null,
- "MasterPackQty": null,
- "ShipStartDate": null,
- "ShipStopDate": null,
- "DeptNum": null,
- "Style": "01901993129061",
- "StyleDescription": "BEATS STUDIO3 WIRELESS OVER-EA",
- "ColorCode": "000",
- "ColorDescription": null,
- "SizeCode": "0000",
- "SizeDescription": null,
- "CatalogVendorNum": null,
- "CatalogDeptNum": null,
- "CatalogCost": null,
- "CatalogRetail": null,
- "Stores": [
- {
- "StoreNum": "16101",
- "StoreCost": 227,
- "StoreRetail": 299.99,
- "StoreOrderUnits": 10,
- "DropLoc": "16101"
}
]
}
]
}
"Success"
The Traverse Systems Flex Query API allows Vision customers to fetch data from Vision by using an existing Flex Query. This endpoint will return a list of related data for the query.
The Traverse Systems Vision Flex Query API allows you to fetch data from a Vision Flex Query. This endpoint will return a list of PO related data for the query.
You should use the Flex Query Id
as a parameter.
Access to this endpoint may differ based on user permissions.
queryId | string The internal ID of the Flex Query to use. |
[- {
- "customerId": 1,
- "id": 1122497,
- "poNum": "2593591",
- "siteNumShipTo": "70001",
- "vendorName": "CRAYOLA LLC",
- "vendorNum": "00001374909",
- "deptNum": "0530",
- "shipStartDt": "2023-04-17T00:00:00",
- "shipStopDt": "2023-04-28T00:00:00",
- "custCreateDt": "2022-12-28T00:00:00",
- "approvedTs": "2022-12-29T00:00:00",
- "cancelDt": null,
- "orderType": "ENTRY",
- "orderStatus": "N",
- "distMethod": "PREPACKED",
- "billType": "Destination/Prepaid",
- "totalUnits": 759,
- "siteNum": "70001",
- "siteName": "RDC MCX WEST COAST",
- "adEvent": "BTS 2023",
- "percentComplete": 0.12648221343873517,
- "incompleteCount": 663,
- "daysFromLastActivity": 207,
- "daysFromShipStop": 207,
- "daysFromEvent": null,
- "events": 1,
- "orderUnits": 759,
- "finalDestQty": 0,
- "finalDestQtyPct": 0,
- "orderCost": 2499.21,
- "finalDestCost": 0,
- "orderRetail": 4116.81,
- "finalDestRetail": 0,
- "inboundShipmentsIncomplete": 1,
- "outboundShipmentsIncomplete": 0,
- "routingRequests": 0,
- "asnShipments": 0,
- "asnPoUnits": 0,
- "asnToPoPct": 0,
- "otherWarehouseReceiptUnits": 0,
- "otherWarehouseTransferUnits": 0,
- "receiptUnits": 96,
- "plannedUnits": 96,
- "pickedUnits": 96,
- "stagedUnits": 96,
- "loadedUnits": 96,
- "shippedUnits": 96,
- "status": "In DC",
- "inShipments": 1,
- "inShipmentsDelivered": 0,
- "inShipmentsShipped": 0,
- "outShipments": 0,
- "outShipmentsDelivered": 0,
- "outShipmentsShipped": 0,
- "lateAsnTotal": 0,
- "lateRrTotal": 0,
- "troubleIndicator": "N",
- "troubleCount": 0
}
]
The Traverse Systems Vision Flex Query API allows you to fetch data from a Vision Flex Query. This endpoint will return a single record with data grouped/summed for the query.
You should use the Flex Query Id
as a parameter.
Access to this endpoint may differ based on user permissions.
queryId | string The internal ID of the Flex Query to use. |
{- "siteNumShipTo": null,
- "siteNameShipTo": null,
- "vendorNum": null,
- "vendorName": null,
- "deptNum": null,
- "deptDescription": null,
- "shipStartMin": null,
- "shipStartMax": null,
- "shipStopMin": null,
- "shipStopMax": null,
- "approvedTsMin": null,
- "approvedTsMax": null,
- "cancelDtMin": null,
- "cancelDtMax": null,
- "events": null,
- "daysFromLastActivityMin": null,
- "daysFromLastActivityMax": null,
- "daysFromLastActivityAvg": null,
- "daysFromEventMin": null,
- "daysFromEventMax": null,
- "daysFromEventAvg": null,
- "daysFromShipStopMin": null,
- "daysFromShipStopMax": null,
- "daysFromShipStopAvg": null,
- "percentComplete": 0.12379110251450677,
- "incompleteCount": 453,
- "poCount": 11,
- "orderUnits": 517,
- "finalDestQty": 64,
- "finalDestQtyPct": 0.12379110251450677,
- "orderCost": 38323.229999999996,
- "finalDestCost": 0,
- "finalDestCostPct": 0,
- "orderRetail": 62594.83,
- "finalDestRetail": 0,
- "finalDestRetailPct": 0,
- "inboundShipmentsIncomplete": 26,
- "outboundShipmentsIncomplete": 0,
- "routingRequests": 11,
- "asnShipments": 15,
- "asnPoUnits": 456,
- "asnToPoPct": 0.8820116054158608,
- "otherWarehouseReceiptUnits": 0,
- "otherWarehouseTransferUnits": 0,
- "receiptUnits": 64,
- "plannedUnits": 64,
- "pickedUnits": 64,
- "stagedUnits": 64,
- "loadedUnits": 64,
- "shippedUnits": 64,
- "inShipments": 26,
- "inShipmentsDelivered": 0,
- "inShipmentsShipped": 11,
- "outShipments": 0,
- "outShipmentsDelivered": 0,
- "outShipmentsShipped": 0,
- "lateAsnTotal": 3,
- "lateRrTotal": 0,
- "troubleIndicator": "N",
- "troubleCount": 0
}
The Traverse Systems Vision Flex Query API allows you to fetch data from a Vision Flex Query. This endpoint will return a list of PO related data for the query grouped/summed by Department.
You should use the Flex Query Id
as a parameter.
Access to this endpoint may differ based on user permissions.
queryId | string The internal ID of the Flex Query to use. |
[- {
- "siteNumShipTo": null,
- "siteNameShipTo": null,
- "vendorNum": null,
- "vendorName": null,
- "deptNum": "0054",
- "deptDescription": "PROGRAM 123",
- "shipStartMin": "2023-12-27T00:00:00",
- "shipStartMax": "2024-02-13T00:00:00",
- "shipStopMin": "2024-01-11T00:00:00",
- "shipStopMax": "2024-03-01T00:00:00",
- "approvedTsMin": "2023-12-27T00:00:00",
- "approvedTsMax": "2024-02-13T00:00:00",
- "cancelDtMin": null,
- "cancelDtMax": null,
- "events": 23,
- "daysFromLastActivityMin": -57,
- "daysFromLastActivityMax": -15,
- "daysFromLastActivityAvg": -45.26086956521739,
- "daysFromEventMin": 0,
- "daysFromEventMax": 0,
- "daysFromEventAvg": 0,
- "daysFromShipStopMin": -54,
- "daysFromShipStopMax": -4,
- "daysFromShipStopAvg": -37.65217391304348,
- "poCount": 23,
- "orderUnits": 37193,
- "finalDestQty": 0,
- "orderCost": 281477.98000000004,
- "finalDestCost": 0,
- "orderRetail": 432166.95999999996,
- "finalDestRetail": 0,
- "routingRequests": 17,
- "asnShipments": 23,
- "asnPoUnits": 31442,
- "otherWarehouseReceiptUnits": 0,
- "otherWarehouseTransferUnits": 0,
- "receiptUnits": 0,
- "plannedUnits": 0,
- "pickedUnits": 0,
- "stagedUnits": 0,
- "loadedUnits": 0,
- "shippedUnits": 0,
- "inShipments": 23,
- "inShipmentsDelivered": 0,
- "inShipmentsShipped": 0,
- "outShipments": 0,
- "outShipmentsDelivered": 0,
- "outShipmentsShipped": 0,
- "lateAsnTotal": 0,
- "lateRrTotal": 0,
- "troubleIndicator": "N",
- "troubleCount": 0,
- "firstReceiptDate": null,
- "lastReceiptDate": null,
- "initialDCDate": null,
- "asnPoCost": 191077.85,
- "asnPoRetail": 316430.95999999996,
- "currentStatus": null,
- "currentStatusDesc": null,
- "minRrDate": "2024-01-03T08:43:00",
- "maxRrDate": "2024-02-15T11:48:00",
- "minAsnDate": "2024-01-08T00:00:00",
- "maxAsnDate": "2024-02-19T00:00:00",
- "finalDestQtyPct": 0,
- "finalDestCostPct": 0,
- "finalDestRetailPct": 0,
- "asnToPoPct": 0.845374129540505,
- "percentComplete": 0,
- "incompleteCount": 37193,
- "inboundShipmentsIncomplete": 23,
- "outboundShipmentsIncomplete": 0
}
]
The Traverse Systems Vision Flex Query API allows you to fetch data from a Vision Flex Query. This endpoint will return a list of PO related data for the query grouped/summed by Ship To Location.
You should use the Flex Query Id
as a parameter.
Access to this endpoint may differ based on user permissions.
queryId | string The internal ID of the Flex Query to use. |
[- {
- "siteNumShipTo": "60001",
- "siteNameShipTo": "Del Rio",
- "vendorNum": null,
- "vendorName": null,
- "deptNum": null,
- "deptDescription": null,
- "shipStartMin": "2024-02-07T00:00:00",
- "shipStartMax": "2024-02-14T00:00:00",
- "shipStopMin": "2024-02-20T00:00:00",
- "shipStopMax": "2024-02-29T00:00:00",
- "approvedTsMin": "2024-02-06T00:00:00",
- "approvedTsMax": "2024-02-13T00:00:00",
- "cancelDtMin": null,
- "cancelDtMax": null,
- "events": 12,
- "daysFromLastActivityMin": -20,
- "daysFromLastActivityMax": -15,
- "daysFromLastActivityAvg": -17.333333333333332,
- "daysFromEventMin": 0,
- "daysFromEventMax": 0,
- "daysFromEventAvg": 0,
- "daysFromShipStopMin": -14,
- "daysFromShipStopMax": -5,
- "daysFromShipStopAvg": -8.5,
- "poCount": 12,
- "orderUnits": 11873,
- "finalDestQty": 0,
- "orderCost": 93567.70999999998,
- "finalDestCost": 0,
- "orderRetail": 143149.52999999997,
- "finalDestRetail": 0,
- "routingRequests": 12,
- "asnShipments": 3,
- "asnPoUnits": 1418,
- "otherWarehouseReceiptUnits": 0,
- "otherWarehouseTransferUnits": 0,
- "receiptUnits": 431,
- "plannedUnits": 431,
- "pickedUnits": 431,
- "stagedUnits": 0,
- "loadedUnits": 0,
- "shippedUnits": 0,
- "inShipments": 3,
- "inShipmentsDelivered": 1,
- "inShipmentsShipped": 1,
- "outShipments": 0,
- "outShipmentsDelivered": 0,
- "outShipmentsShipped": 0,
- "lateAsnTotal": 0,
- "lateRrTotal": 0,
- "troubleIndicator": "N",
- "troubleCount": 0,
- "firstReceiptDate": "2024-02-15T00:00:00",
- "lastReceiptDate": "2024-02-15T00:00:00",
- "initialDCDate": "2024-02-15T00:00:00",
- "asnPoCost": 4354.01,
- "asnPoRetail": 6773.82,
- "currentStatus": null,
- "currentStatusDesc": null,
- "minRrDate": "2024-02-14T13:57:00",
- "maxRrDate": "2024-02-19T09:07:00",
- "minAsnDate": "2024-02-13T00:00:00",
- "maxAsnDate": "2024-02-19T00:00:00",
- "finalDestQtyPct": 0,
- "finalDestCostPct": 0,
- "finalDestRetailPct": 0,
- "asnToPoPct": 0.11943064095005475,
- "percentComplete": 0.03630085066958646,
- "incompleteCount": 11442,
- "inboundShipmentsIncomplete": 2,
- "outboundShipmentsIncomplete": 0
}
]
The Traverse Systems Vision Flex Query API allows you to fetch data from a Vision Flex Query. This endpoint will return a list of PO related data for the query grouped/summed by Vendor.
You should use the Flex Query Id
as a parameter.
Access to this endpoint may differ based on user permissions.
queryId | string The internal ID of the Flex Query to use. |
[- {
- "siteNumShipTo": null,
- "siteNameShipTo": null,
- "vendorNum": "00051825347",
- "vendorName": "MY FOODS",
- "deptNum": null,
- "deptDescription": null,
- "shipStartMin": "2023-12-15T00:00:00",
- "shipStartMax": "2024-02-14T00:00:00",
- "shipStopMin": "2023-12-28T00:00:00",
- "shipStopMax": "2024-02-27T00:00:00",
- "approvedTsMin": "2023-12-13T00:00:00",
- "approvedTsMax": "2024-02-13T00:00:00",
- "cancelDtMin": null,
- "cancelDtMax": null,
- "events": 28,
- "daysFromLastActivityMin": -49,
- "daysFromLastActivityMax": -15,
- "daysFromLastActivityAvg": -29.464285714285715,
- "daysFromEventMin": 0,
- "daysFromEventMax": 95,
- "daysFromEventAvg": 3.392857142857143,
- "daysFromShipStopMin": -68,
- "daysFromShipStopMax": -7,
- "daysFromShipStopAvg": -30.035714285714285,
- "poCount": 28,
- "orderUnits": 18269,
- "finalDestQty": 0,
- "orderCost": 196924.28000000003,
- "finalDestCost": 0,
- "orderRetail": 304434.60000000003,
- "finalDestRetail": 0,
- "routingRequests": 29,
- "asnShipments": 15,
- "asnPoUnits": 8238,
- "otherWarehouseReceiptUnits": 521,
- "otherWarehouseTransferUnits": 0,
- "receiptUnits": 0,
- "plannedUnits": 0,
- "pickedUnits": 0,
- "stagedUnits": 0,
- "loadedUnits": 0,
- "shippedUnits": 0,
- "inShipments": 16,
- "inShipmentsDelivered": 1,
- "inShipmentsShipped": 2,
- "outShipments": 0,
- "outShipmentsDelivered": 0,
- "outShipmentsShipped": 0,
- "lateAsnTotal": 5,
- "lateRrTotal": 6,
- "troubleIndicator": "N",
- "troubleCount": 0,
- "firstReceiptDate": null,
- "lastReceiptDate": null,
- "initialDCDate": "2024-02-15T00:00:00",
- "asnPoCost": 78422.02,
- "asnPoRetail": 121248.91,
- "currentStatus": null,
- "currentStatusDesc": null,
- "minRrDate": "2024-01-16T13:41:00",
- "maxRrDate": "2024-02-16T15:24:00",
- "minAsnDate": "2024-01-17T00:00:00",
- "maxAsnDate": "2024-02-19T00:00:00",
- "finalDestQtyPct": 0,
- "finalDestCostPct": 0,
- "finalDestRetailPct": 0,
- "asnToPoPct": 0.45092780119327824,
- "percentComplete": 0,
- "incompleteCount": 18269,
- "inboundShipmentsIncomplete": 15,
- "outboundShipmentsIncomplete": 0
}
]
The Traverse Systems Vision Flex Query API allows you to fetch data from a Vision Flex Query. This endpoint will return a list of PO Details for the query grouped/summed by Store.
You should use the Flex Query Id
as a parameter.
Access to this endpoint may differ based on user permissions.
queryId | string The internal ID of the Flex Query to use. |
[- {
- "siteId": 320,
- "siteNum": "10101",
- "siteName": "Dallas",
- "shipStartMin": "2023-08-23T00:00:00",
- "shipStartMax": "2024-02-04T00:00:00",
- "shipStopMin": "2023-09-04T00:00:00",
- "shipStopMax": "2024-02-16T00:00:00",
- "approvedTsMin": "2023-12-07T00:00:00",
- "approvedTsMax": "2024-02-02T00:00:00",
- "cancelDtMin": null,
- "cancelDtMax": null,
- "daysFromLastActivityMin": -89,
- "daysFromLastActivityMax": -17,
- "daysFromEventMin": 0,
- "daysFromEventMax": 186,
- "daysFromShipStopMin": -183,
- "daysFromShipStopMax": -18,
- "storeCost": 7604.389999999996,
- "storeRetail": 10171.94999999998,
- "storeUnits": 3795,
- "storeCount": 520,
- "finalDestUnits": 0,
- "totalAsnCost": 172418.5600000002,
- "totalAsnRetail": 192422.27000000014,
- "asnUnits": 2981,
- "wmsUnits": 352,
- "asnCartons": 254,
- "wmsCartons": 53,
- "troubleIndicator": null,
- "troubleCount": 0,
- "asnToPoPct": 0.7855072463768116,
- "wmsToAsnPercent": 0.11808118081180811,
- "finalDestToPoPercent": 0
}
]
The Traverse Systems Vision Flex Query API allows you to fetch data from a Vision Flex Query. This endpoint will return a list of WMS Carton related data for the query.
You should use the Flex Query Id
as a parameter.
Access to this endpoint may differ based on user permissions.
queryId | string The internal ID of the Flex Query to use. |
[- {
- "vendorName": "CORE LABORATORIES",
- "vendorNum": "00055991053",
- "wmsCartonNum": "15822217",
- "deptNum": "0851",
- "deptDesc": "JEWELRY",
- "deptGroup": null,
- "gs1128": "8863890115828036",
- "asnNum": "145754346",
- "asnUnits": 48,
- "asnItems": 2,
- "asnReceiptTs": "2023-11-22T00:00:00",
- "wmsItems": 2,
- "id": 1958263,
- "poNum": "2706173",
- "poAdEvent": "2023-12",
- "wmsReceiptTs": "2023-11-30T00:00:00",
- "transferTs": null,
- "asnReceived": "N",
- "cartonStatus": "Outbound",
- "cartonStatusTs": "2023-12-01T08:08:00",
- "direction": null,
- "receiverNumbers": "617455692",
- "siteNumWh": "60001",
- "siteNumOtherWh": null,
- "siteNum": "2100",
- "plannedQty": 48,
- "pickedQty": 48,
- "stagedQty": 48,
- "loadedQty": 48,
- "shippedQty": 48,
- "completeQty": 2,
- "otherWhReceiptTs": null,
- "otherWhReceiptQty": 0,
- "otherWhTransferQty": 0,
- "wmsLocationNum": "COMPLETE",
- "initialDcReceiptQty": 48,
- "daysFromLastActivity": -95
}
]
The Traverse Systems Vision Receipt Summary API allows Vision customers to send a summarized Receipt data to Vision. The Receipt Summary aggregates data by Receipt and PO.
This API endpoint receives JSON data representing a summary of a Receipt. The receipt data should be summarized per Receipt and PO.
Access to this endpoint may differ based on user permissions.
The request body should contain JSON data representing an Receipt Summary.
PoNum | string |
ReceiptNum | string |
ReceiptDate | date-time or null |
ProNum | string or null |
BolNum | string or null |
ReceiptLocNum | string |
Cartons | number or null |
Units | number or null |
Cost | number or null |
Retail | number or null |
Items | integer or null |
Skus | integer or null |
Upcs | integer or null |
Stores | integer or null |
An Example Receipt Summary.
{- "PoNum": "2558455JR",
- "ReceiptNum": "063902620",
- "ReceiptDate": "2023-07-08T00:00:00",
- "ProNum": "63902620",
- "BolNum": null,
- "ReceiptLocNum": "15100",
- "Cartons": 1,
- "Units": 1,
- "Cost": 145.63,
- "Retail": 145.63,
- "Items": 1,
- "Skus": 1,
- "Upcs": 1,
- "Stores": 1
}
"Success"
The Traverse Systems Vision Routing Request API allows Vision customers to send a Routing Request to Vision. Once a retailer has ordered product, the vendor must know how the buyer wants the shipment delivered. The routing request consolidates the necessary information for that query. A Routing Request should contain Purchase Orders and be for a specific origin and destination.
This API endpoint receives JSON data representing a Routing Request.
Access to this endpoint may differ based on user permissions.
The request body should contain JSON data representing an Routing Request.
RoutingRequestNum | string |
RoutingDate | date-time |
VendorNum | string |
OriginLocation | string |
OriginAddress1 | string |
OriginAddress2 | string |
OriginAddress3 | string |
OriginAddress4 | string |
OriginCity | string |
OriginState | string |
OriginZip | string |
CountryCode | string |
OriginLocClerk | string |
OriginLocClerkPhone | string |
OriginLocClerkEmail | string |
DestinationLocationNumber | string |
ShipmentReadyDate | date-time or null |
AuthorizationNum | string |
ApprovedDate | date-time or null |
Scac | string |
ModeOrShipmentType | string |
ServiceMethod | string |
ExpectedPickupDate | date-time or null |
ActualPickupDate | date-time or null |
ArrivalDate | date-time or null |
CarrierConfirmation | string |
StatusCode | string |
RequestType | string |
BillType | string |
AltStatus | string |
ConsolidatorPoint | string |
ConsolidatorState | string |
TenderDate | date-time or null |
DeliveryAppointmentDate | date-time or null |
Cartons | integer |
Units | integer |
Pallets | integer |
Weight | integer |
Cube | integer |
ProNum | string |
Array of objects or null (RoutingRequestDetail) A list of Routing Request Details |
An Example Routing Request.
{- "$ref": "../components/examples/routing-request.yaml"
}
"Success"
The Traverse Systems Vision Shipment API allows Vision customers to send a Shipment to Vision. The Shipment describes the current state of the shipment from origin to destination. The events can range from tracking started to delivered.
This API endpoint receives JSON data representing a Shipment including all of it's Event information.
Access to this endpoint may differ based on user permissions.
The request body should contain JSON data representing an Shipment.
ShipmentNum | string |
Scac | string |
BolNum | string or null |
ProNum | string or null |
AuthorizationNum | string or null |
ContainerNum | string or null |
BookingNum | string or null |
EquipmentTypeCode | string or null |
EquipmentStatusCode | string or null |
EquipmentStatusDesc | string or null |
SealNum | string or null |
TransportationControlNum | string or null |
IsInbound | boolean or null |
ArrivedAtPickupTs | date-time or null |
LoadedTs | date-time or null |
OriginAddress1 | string or null |
OriginAddress2 | string or null |
OriginAddress3 | string or null |
OriginAddress4 | string or null |
OriginCity | string or null |
OriginState | string or null |
OriginZip | string or null |
OriginCountryCode | string or null |
OriginLatitude | decimal or null |
OriginLongitude | decimal or null |
DestAddress1 | string or null |
DestAddress2 | string or null |
DestAddress3 | string or null |
DestAddress4 | string or null |
DestCity | string or null |
DestState | string or null |
DestZip | string or null |
DestCountryCode | string or null |
DestLatitude | decimal or null |
DestLongitude | decimal or null |
DepartedPickupScheduledTs | date-time or null |
DepartedPickupEtaTs | date-time or null |
DepartedPickupTs | date-time or null |
ArrivedAtDestScheduledTs | date-time or null |
ArrivedAtDestEtaTs | date-time or null |
ArrivedAtDestTs | date-time or null |
CarrierEtaAtFinalDest | date-time or null |
DataSource | string |
DataSourceType | string |
Array of objects or null (ShipmentEvent) A list of Shipment Events |
An Example Shipment.
{- "$ref": "../components/examples/shipment.yaml"
}
"Success"
The Traverse Systems Vision Shipment Delivery Status API allows Vision customers to send a Shipment Delivery Status to Vision. The Shipment Delivery Status describes the current state of the shipment from origin to destination. The statuses can range from pending, to in transit, to describing delivery attempts.
This API endpoint receives a data file with data representing an EDI 214 or a Shipment Delivery Status. Datafile layout is determined during implementation.
Access to this endpoint may differ based on user permissions.
The request body should contain JSON data representing an Shipment Delivery Status File.
null
"Success"
The Traverse Systems Vision Site API allows Vision customers to send a Site to Vision. A Site is any location/facility used by the organization. These can include stores, ecommerce locations, distribution centers, warehouses, or corporate headquarters. Site information includes locations, phone numbers, type of location, shipping start/stop dates, and more. Addresses are used to provide a graphic map of locations.
This API endpoint receives JSON data representing a Site, Store, Distribution Center or other building.
Access to this endpoint may differ based on user permissions.
The request body should contain JSON data representing an Site.
SiteNum | string |
Name | string |
SiteType | string or null |
Phone | string or null |
Fax | string |
Address1 | string or null |
Address2 | string or null |
Address3 | string or null |
Address4 | string or null |
City | string or null |
State | string or null |
Zip | string or null |
CountryCode | string or null |
District | string or null |
Region | string or null |
SiteOpenDate | date-time or null |
SiteCloseDate | string or null |
SiteShipStartDate | date-time or null |
SiteShipStopDate | date-time or null |
BusinessUnitName | string or null |
DropLoc | string or null |
GlAccount | string or null |
An Example Site.
{- "SiteNum": "70001JR",
- "Name": "Lufkin",
- "SiteType": null,
- "Phone": "888-203-0608",
- "Fax": null,
- "Address1": "Demo1 RDC WEST c/o Demo1",
- "Address2": "879 S. WATERMAN AVE",
- "Address3": null,
- "Address4": null,
- "City": "SAN BERNARDINO",
- "State": "CA",
- "Zip": "92408",
- "CountryCode": "USA",
- "District": null,
- "Region": null,
- "SiteOpenDate": "2015-04-13T00:00:00",
- "SiteCloseDate": null,
- "SiteShipStartDate": null,
- "SiteShipStopDate": null,
- "BusinessUnitName": "La Porte",
- "DropLoc": "70001",
- "GlAccount": null
}
"Success"
The Traverse Systems Vision Store Scan API allows Vision customers to send a Store Scan to Vision. Since this scanning event is at the final destination, it signals the final status for those goods.
This API endpoint receives JSON data representing the scanning of items at the Store or Destination.
Access to this endpoint may differ based on user permissions.
The request body should contain JSON data representing an Store Scan.
SiteNum | string |
PoNum | string or null |
ReceiptNum | string or null |
TransferNum | string or null |
DocumentType | string Value should be either |
UserName | string or null |
DocCreateDate | date-time or null |
DocUpdateDate | date-time or null |
TfIndicator | string or null |
An Example Store Scan.
{- "$ref": "../components/examples/store-scan.yaml"
}
"Success"
This API endpoint receives a data file with data representing the scanning of items at the Store or Destination.
Access to this endpoint may differ based on user permissions.
The request body should contain JSON data representing an Store Scan.
null
"Success"
The Traverse Systems Vision Trouble Summary API allows Vision customers to send summarized data about problems in the distribution center. Because a Trouble prevents the transfer of responsibility for goods, maintaining clear, up-to-date details about any Trouble is crucial to determining the appropriate action.
This API endpoint receives JSON data representing the trouble information for a PO. Data should be grouped and summed by PO.
Access to this endpoint may differ based on user permissions.
The request body should contain JSON data representing an Trouble Summary.
PoNum | string |
TroubleDate | date-time or null |
TroubleCount | integer or null |
TotalAvgDays | numeric or null |
TotalIssues | integer or null |
TotalUnits | integer or null |
OpenTroubles | integer or null |
OpenTroubleMaxAge | numeric or null |
OpenIssues | integer or null |
OpenUnits | integer or null |
An Example Trouble Summary.
{- "PoNum": "2558455JR",
- "TroubleDate": "2015-04-13T00:00:00",
- "TroubleCount": 1,
- "TotalAvgDays": 2.5,
- "TotalIssues": 1,
- "TotalUnits": 1,
- "OpenTroubles": 0,
- "OpenTroubleMaxAge": 1.25,
- "OpenIssues": 0,
- "OpenUnits": 0
}
"Success"
The Traverse Systems Vision WMS Detail API allows Vision customers to send Warehouse Management System detail data to Vision. The fields available for query include everything from the Site number to pallet and Item numbers.
This API endpoint receives JSON data representing WMS Detail data. This data should be grouped at the Carton or LP and Item level.
Access to this endpoint may differ based on user permissions.
The request body should contain JSON data representing an WMS Detail.
WmsNum | string |
RefNum | string |
WmsCartonNum | string |
WmsCreateDate | date-time |
WmsUpdateDate | date-time or null |
SiteNumWh | string |
WmsType | string Value should be either |
PoNum | string or null |
WmsOrderNum | string or null |
OrderDate | date-time or null |
ItemNum | string |
LineNum | string or null |
WmsPalletNum | string or null |
SiteNum | string |
OtherWhReceiptDate | date-time or null |
OtherWhReceiptQty | integer or null |
OtherWhTransferDate | date-time or null |
OtherWhTransferQty | integer or null |
ReceiptDate | date-time or null |
ReceiptQty | integer or null |
PlannedQty | integer or null |
PickedDate | date-time or null |
PickedQty | integer or null |
StagedDate | date-time or null |
StagedQty | integer or null |
LoadedDate | date-time or null |
LoadedQty | integer or null |
ShippedDate | date-time or null |
ShippedQty | integer or null |
Gs1128 | string or null |
LoadNum | string or null |
ReceiptNum | string or null |
WmsLocationNum | string or null The location in the warehouse |
CompleteFlag | string or null |
OrigReceiptTranType | string or null |
SiteNumOthWh | string or null |
PutAwayFlag | string or null |
AdjustedOut | string or null |
ContainerNum | string or null |
BookingNum | string or null |
An Example WMS Detail.
{- "WmsNum": "16299222",
- "RefNum": "0FE308DA-AF71-4BBC-8918-BF06FE64D9C9",
- "WmsCartonNum": "14332579JR",
- "WmsCreateDate": "2023-06-30T09:40:59",
- "WmsUpdateDate": "2023-07-01T04:40:31",
- "SiteNumWh": "60001",
- "WmsType": "FLOW",
- "PoNum": "2558455JR",
- "WmsOrderNum": "31455198",
- "OrderDate": "2023-06-30T09:19:09",
- "ItemNum": "033808104277760000000",
- "LineNum": 6,
- "WmsPalletNum": "300602416",
- "SiteNum": "02100",
- "OtherWhReceiptDate": null,
- "OtherWhReceiptQty": 0,
- "OtherWhTransferDate": null,
- "OtherWhTransferQty": 0,
- "ReceiptDate": "2023-06-30T00:00:00",
- "ReceiptQty": 3,
- "PlannedQty": 3,
- "PickedDate": "2023-06-30T09:25:34",
- "PickedQty": 3,
- "StagedDate": "2023-06-30T13:36:26",
- "StagedQty": 3,
- "LoadedDate": null,
- "LoadedQty": 0,
- "ShippedDate": null,
- "ShippedQty": 0,
- "Gs1128": "00003380810045452597",
- "LoadNum": "M1010953",
- "ReceiptNum": "616359605",
- "WmsLocationNum": "",
- "CompleteFlag": "",
- "OrigReceiptTranType": "161",
- "SiteNumOthWh": "",
- "PutAwayFlag": "",
- "AdjustedOut": "N",
- "ContainerNum": null,
- "BookingNum": null
}
"Success"
This API endpoint receives a data file representing WMS Detail data. This data should be grouped at the Carton or LP and Item level.
Access to this endpoint may differ based on user permissions.
The request body should contain JSON data representing an WMS Detail file.
null
"Success"
The Traverse Systems Vision Vendor API allows Vision customers to send robust Vendor or Supplier data to Vision, including addresses, active (y/n), type, number, and more.
This API endpoint receives JSON data representing a Vendor or Supplier.
Access to this endpoint may differ based on user permissions.
The request body should contain JSON data representing an Vendor.
VendorNum | string |
Name | string |
Active | string Value should be either |
Ein | string or null |
Duns | string or null |
CertifiedFlag | string Value should be either |
VendorType | string or null |
ApVendorNum | string or null |
ApVendorName | string or null |
ParentVendorNum | string or null |
ParentCompany | string or null |
FactorNum | string or null |
FrtPaymentType | string or null |
CurrencyCode | string or null |
RemitAddress1 | string or null |
RemitAddress2 | string or null |
RemitAddress3 | string or null |
RemitAddress4 | string or null |
RemitCity | string or null |
RemitState | string or null |
RemitZip | string or null |
CountryCode | string or null |
An Example Vendor.
{- "VendorNum": "00142451827JR",
- "Name": "SON SCHEIN PRESS",
- "Active": "Y",
- "Ein": null,
- "Duns": null,
- "CertifiedFlag": "N",
- "VendorType": null,
- "ApVendorNum": null,
- "ApVendorName": null,
- "ParentVendorNum": null,
- "ParentCompany": null,
- "FactorNum": null,
- "FrtPaymentType": null,
- "CurrencyCode": "USD",
- "RemitAddress1": "9750 ABERDEEN ROAD",
- "RemitAddress2": null,
- "RemitAddress3": null,
- "RemitAddress4": null,
- "RemitCity": "ABERDEEN",
- "RemitState": "NC",
- "RemitZip": "28315",
- "CountryCode": "USA"
}
"Success"