logo
API docs by Redocly

Visibility Data Api (1.0.0)

Download OpenAPI specification:Download

E-mail: helpdesk@traversesystems.com License: Apache 2.0 Terms of Service

Introduction

The SPS Commerce Visibility API is a great tool to power your internal tools or transfer data to SPS Commerce Visibility. 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:

OpenAPI Specification

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.

Authentication

Available authentication methods for Visibility:

  • Basic Authentication

basic_auth

The endpoint requires an authorization header containing a Base64 encoded string in the format of "KeyName:ApiKey"

Security Scheme Type: HTTP
HTTP Authorization Scheme: basic

Version History

The goal of The OpenAPI Specification is to define a standard, language-agnostic interface to REST APIs which

Application Advice

The SPS Commerce Visibility Application Advice API allows Visibility customers to send an Application Advice to Visibility. Once in Visibility, recipients can view the Application Advice and ensure they are prepared to process the information. The Application Advice includes details such as the application type, status, and related data.

Send an Application Advice

This API endpoint receives JSON data representing an Application Advice.

Access to this endpoint may differ based on user permissions.

Authorizations:
basic_auth
Request Body schema: application/json

The request body should contain JSON data representing an Application Advice.

ApplicationAdviceNumber
string
TransactionPurposeCode
string or null
TransactionPurposeDescription
string or null
ApplicationAdviceDt
date-time or null
InterchangeControlNumber
string or null
GroupControlNumber
string or null
TransactionControlNumber
string or null
InterchangeSenderId
string or null
InterchangeReceiverId
string or null
InterchangeSenderIdQualifier
string or null
InterchangeReceiverIdQualifier
string or null
GroupSenderId
string or null
GroupReceiverId
string or null
RawEdiIdentifier
string or null
RawEdiFileName
string or null
OriginalInterchangeSenderId
string or null
OriginalGroupSenderId
string or null
ContactName
string or null
ContactEmail
string or null
ContactPhone
string or null
EdiSentTs
date-time or null
Array of objects (ApplicationAdviceDetail)

A list of Application Advice Details

Responses

Request samples

Content type
application/json

An Example Application Advice.

{
  • "ApplicationAdviceNumber": "824-20220920-001",
  • "TransactionPurposeCode": "TR",
  • "TransactionPurposeDescription": "Transaction Set Reject",
  • "ApplicationAdviceDt": "2022-09-20T00:00:00",
  • "InterchangeControlNumber": "ICN-20002",
  • "GroupControlNumber": "GCN-10001",
  • "TransactionControlNumber": "TCN-30003",
  • "InterchangeSenderId": "IS-004",
  • "InterchangeReceiverId": "IR-003",
  • "InterchangeSenderIdQualifier": "01",
  • "InterchangeReceiverIdQualifier": "01",
  • "GroupSenderId": "GS-002",
  • "GroupReceiverId": "GR-001",
  • "RawEdiIdentifier": "824",
  • "RawEdiFileName": "824_20220920_001.edi",
  • "OriginalInterchangeSenderId": "OIS-001",
  • "OriginalGroupSenderId": "OGS-001",
  • "ContactName": "Jane Smith",
  • "ContactEmail": "jane.smith@vendor.com",
  • "ContactPhone": "555-123-4567",
  • "EdiSentTs": "2022-09-20T14:30:00",
  • "Details": [
    ]
}

Response samples

Content type
application/json
"Success"

Asn

The SPS Commerce Visibility ASN API allows Visibility customers to send an Advanced Ship Notice (ASN) to Visibility. Once in Visibility, 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.

Send an ASN

This API endpoint receives JSON data representing an Advanced Ship Notice.

Access to this endpoint may differ based on user permissions.

Authorizations:
basic_auth
Request Body schema: application/json

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
GroupReceiverID
string or null
GroupSenderID
string or null
InterchangeReceiverID
string or null
InterchangeSenderID
string or null
GroupControlNumber
string or null
InterchangeControlNumber
string or null
InterchangeReceiverIdQualifier
string or null
InterchangeSenderIdQualifier
string or null
RawEdiIdentifier
string or null
RawEdiFileName
string or null
TransactionControlNumber
string or null
TransactionTypeCode
string or null
EdiSentTs
date-time or null
Array of objects or null (AsnCarton)

A list of ASN Cartons

Responses

Request samples

Content type
application/json

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",
  • "DropLoc": null,
  • "Division": null,
  • "ExpectedDeliveryDate": "2022-09-20T00:00:00",
  • "PoUniqueAddenda": "20220912",
  • "AuthorizationNum": null,
  • "GroupReceiverID": "GR-001",
  • "GroupSenderID": "GS-002",
  • "InterchangeReceiverID": "IR-003",
  • "InterchangeSenderID": "IS-004",
  • "GroupControlNumber": "GCN-10001",
  • "InterchangeControlNumber": "ICN-20002",
  • "InterchangeReceiverIdQualifier": "01",
  • "InterchangeSenderIdQualifier": "01",
  • "RawEdiIdentifier": "856",
  • "RawEdiFileName": "856_20220920_001.edi",
  • "TransactionControlNumber": "TCN-30003",
  • "TransactionTypeCode": "00",
  • "EdiSentTs": "2022-09-20T00:00:00",
  • "Cartons": [
    ]
}

Response samples

Content type
application/json
"Success"

Credit Debit Adjustment

The SPS Commerce Visibility Credit Debit Adjustment API allows Visibility customers to send a Credit/Debit Adjustment to Visibility.

Send a Credit/Debit Adjustment

This API endpoint receives JSON data representing a Credit/Debit Adjustment, including all of its details.

Access to this endpoint may differ based on user permissions.

Authorizations:
basic_auth
Request Body schema: application/json

The request body should contain JSON data representing a Credit/Debit Adjustment.

CreditDebitAdjNum
string

CreditDebitAdjNum is required

InvoiceNum
string

InvoiceNum is required

PoNum
string or null
PoUniqueAddenda
string or null
PoCreateDt
date-time or null
InvoiceDt
date-time or null
CreditDebitAdjDt
date-time or null
VendorNum
string

VendorNum is required

PayVendorNum
string or null
GroupReceiverID
string or null
GroupSenderID
string or null
InterchangeReceiverID
string or null
InterchangeSenderID
string or null
GroupControlNumber
string or null
InterchangeControlNumber
string or null
TransactionControlNumber
string or null
RawEdiIdentifier
string or null
RawEdiFileName
string or null
InterchangeReceiverIdQualifier
string or null
InterchangeSenderIdQualifier
string or null
EdiSentDt
date-time or null
TransactionTypeCode
string or null
TransactionTypeDescription
string or null
TransactionHandlingCode
string or null
TransactionHandlingDescription
string or null
Amount
number or null
CreditDebitFlag
string or null
InvoiceTotalAmount
number or null
AllowanceCode
string or null
AllowanceAmount
number or null
Array of objects (CreditDebitAdjustmentDetail)

A list of Credit/Debit Adjustment Details

Responses

Request samples

Content type
application/json

An Example Credit/Debit Adjustment.

{
  • "CreditDebitAdjNum": "CDA-20220920-001",
  • "InvoiceNum": "INV-2022-00451",
  • "PoNum": "2558455JR",
  • "PoUniqueAddenda": "20220912",
  • "PoCreateDt": "2022-08-15T00:00:00",
  • "InvoiceDt": "2022-09-20T00:00:00",
  • "CreditDebitAdjDt": "2022-09-25T00:00:00",
  • "VendorNum": "00004919486",
  • "PayVendorNum": "00004919486",
  • "GroupReceiverID": "GR-001",
  • "GroupSenderID": "GS-002",
  • "InterchangeReceiverID": "IR-003",
  • "InterchangeSenderID": "IS-004",
  • "GroupControlNumber": "GCN-10001",
  • "InterchangeControlNumber": "ICN-20002",
  • "TransactionControlNumber": "TCN-30003",
  • "RawEdiIdentifier": "812",
  • "RawEdiFileName": "812_20220925_001.edi",
  • "InterchangeReceiverIdQualifier": "01",
  • "InterchangeSenderIdQualifier": "01",
  • "EdiSentDt": "2022-09-25T14:30:00",
  • "TransactionTypeCode": "CR",
  • "TransactionTypeDescription": "Credit",
  • "TransactionHandlingCode": "C",
  • "TransactionHandlingDescription": "Credit Memo",
  • "Amount": 45.32,
  • "CreditDebitFlag": "C",
  • "InvoiceTotalAmount": 358.11,
  • "AllowanceCode": "PRICE",
  • "AllowanceAmount": 45.32,
  • "Details": [
    ]
}

Response samples

Content type
application/json
"Success"

Dept

The SPS Commerce Visibility Department API allows Visibility customers to send a Department to Visibility. The Department can include a number, a sub department number, a description, a class, and groups.

Send a Department

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.

Authorizations:
basic_auth
Request Body schema: application/json

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

Responses

Request samples

Content type
application/json

An Example Department.

{
  • "DeptNum": "0994t1",
  • "Description": "W BRANDED SWIM",
  • "SubDeptNum": null,
  • "Class": null,
  • "Groups": [
    ]
}

Response samples

Content type
application/json
"Success"

Flex Query

The SPS Commerce Visibility Flex Query API allows Visibility customers to fetch data from Visibility by using an existing Flex Query. This endpoint will return a list of related data for the query.

Get Po Query

The SPS Commerce Visibility Flex Query API allows you to fetch data from a Visibility 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.

Authorizations:
basic_auth
query Parameters
queryId
string

The internal ID of the Flex Query to use.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Po Aggregate Query

The SPS Commerce Visibility Flex Query API allows you to fetch data from a Visibility 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.

Authorizations:
basic_auth
query Parameters
queryId
string

The internal ID of the Flex Query to use.

Responses

Response samples

Content type
application/json
{
  • "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
}

Get Po Aggregate By Dept Query

The SPS Commerce Visibility Flex Query API allows you to fetch data from a Visibility 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.

Authorizations:
basic_auth
query Parameters
queryId
string

The internal ID of the Flex Query to use.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Po Aggregate By Ship To Query

The SPS Commerce Visibility Flex Query API allows you to fetch data from a Visibility 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.

Authorizations:
basic_auth
query Parameters
queryId
string

The internal ID of the Flex Query to use.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Po Aggregate By Vendor Query

The SPS Commerce Visibility Flex Query API allows you to fetch data from a Visibility 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.

Authorizations:
basic_auth
query Parameters
queryId
string

The internal ID of the Flex Query to use.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Po Detail By Store Query

The SPS Commerce Visibility Flex Query API allows you to fetch data from a Visibility 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.

Authorizations:
basic_auth
query Parameters
queryId
string

The internal ID of the Flex Query to use.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get WMS Carton Query

The SPS Commerce Visibility Flex Query API allows you to fetch data from a Visibility 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.

Authorizations:
basic_auth
query Parameters
queryId
string

The internal ID of the Flex Query to use.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Functional Acknowledgement

The SPS Commerce Visibility Functional Acknowledgement API allows Visibility customers to send a Functional Acknowledgement to Visibility.

Send a Functional Acknowledgement

This API endpoint receives JSON data representing a Functional Acknowledgement.

Access to this endpoint may differ based on user permissions.

Authorizations:
basic_auth
Request Body schema: application/json

The request body should contain JSON data representing an Functional Acknowledgement.

DocumentKey
string
AcknowledgementType
string or null
TradingPartnerName
string or null
DocumentType
string or null
DocumentIdentifierType
string or null
DocumentIdentifier
string or null
DocumentStatus
string or null
AcknowledgementDt
date-time or null
PartnerService
string or null
ControlNumberEnvelope
string or null
ControlNumberGroup
string or null
ControlNumberDocument
string or null

Responses

Request samples

Content type
application/json

An Example Functional Acknowledgement.

{
  • "AcknowledgementType": "ACKNOWLEDGEMENT",
  • "DocumentKey": "1726858460",
  • "TradingPartnerName": "My Customer",
  • "DocumentType": "850",
  • "DocumentIdentifierType": "PONumber",
  • "DocumentIdentifier": "7601333",
  • "DocumentStatus": "accepted",
  • "AcknowledgementDt": "2016-04-21T15:07:30+00:00",
  • "PartnerService": "EDI",
  • "ControlNumberEnvelope": "000001383",
  • "ControlNumberGroup": "1518",
  • "ControlNumberDocument": "1518"
}

Response samples

Content type
application/json
"Success"

Inventory Advice

The SPS Commerce Visibility Inventory Advice API allows Visibility customers to send an Inventory Advice to Visibility.

Send a Inventory Advice

This API endpoint receives JSON data representing a Inventory Advice.

Access to this endpoint may differ based on user permissions.

Authorizations:
basic_auth
Request Body schema: application/json

The request body should contain JSON data representing an Inventory Advice.

DocumentNum
string

DocumentNum is required

VendorNum
string

VendorNum is required

LocNum
string or null
LocName
string or null
AddressLine1
string or null
AddressLine2
string or null
AddressLine3
string or null
City
string or null
State
string or null
Zip
string or null
EdiReceivedDt
date-time or null
FacilityLoc
string or null
Array of objects or null (InventoryAdviceDetail)

A list of Inventory Advice Details

Responses

Request samples

Content type
application/json

An Example Inventory Advice.

{
  • "DocumentNum": "129",
  • "VendorNum": "989898",
  • "LocNum": "989",
  • "LocName": "Main Warehouse North",
  • "AddressLine1": "123 Supply Lane",
  • "AddressLine2": "Suite 200",
  • "AddressLine3": "Building A",
  • "City": "Georgetown",
  • "State": "TX",
  • "Zip": "12345",
  • "EdiReceivedDt": "2024-11-04T00:00:00",
  • "FacilityLoc": "989",
  • "Detail": {
    }
}

Response samples

Content type
application/json
"Success"

Invoice

The SPS Commerce Visibility Invoice API allows Visibility customers to send an Invoice to Visibility.

Send a Invoice

This API endpoint receives JSON data representing a Invoice, including all of its details.

Access to this endpoint may differ based on user permissions.

Authorizations:
basic_auth
Request Body schema: application/json

The request body should contain JSON data representing an Invoice.

InvoiceNum
string

InvoiceNum is required

PoNum
string

PoNum is required

InvoiceDt
date-time or null
InvoiceDueDt
date-time or null
PoCreateDt
date-time or null
InvoiceVendorNum
string or null
PayToVendorNum
string or null
Duns
string or null
CartonCount
number or null
TermsType
string or null
InvoiceTermsDt
date-time or null
RetailerTermsDiscDt
date-time or null
RetailerDueDt
date-time or null
TermsDiscPct
number or null
TermsDiscDays
number or null
TermNetDays
number or null
NetDueDt
date-time or null
DefAmtDue
number or null
PctInvPayable
number or null
MerchDol
number or null
NonMerchDol
number or null
Freight
number or null
TermsDiscAmt
number or null
TotalInvAmt
number or null
NetAmtDue
number or null
PaymentDueDt
date-time or null
BolNum
string or null
ShipToLoc
string or null
MarkForLoc
string or null
ProNum
string or null
TotalCartons
number or null
ShipDt
date-time or null
DeptNum
string or null
NumberOfLines
number or null
TransactionType
string or null
PackSlip
string or null
ShipFromLoc
string or null
BillTo
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
Fob
string or null
Uom
string or null
ReceivedDt
date-time or null
OriginalInvoiceNum
string or null
InterchangeSenderId
string or null
InterchangeReceiverId
string or null
GroupSenderId
string or null
GroupReceiverId
string or null
RawEdiIdentifier
string or null
RawEdiFileName
string or null
GroupControlNumber
string or null
InterchangeControlNumber
string or null
InterchangeReceiverIdQualifier
string or null
InterchangeSenderIdQualifier
string or null
TransactionControlNumber
string or null
TransactionTypeCode
string or null
EdiSentTs
date-time or null
Allowance
string or null
AllowanceAmt
number or null
AllowancePct
number or null
Charge
string or null
ChargeAmt
number or null
ChargePct
number or null
TermsOfSaleTypeCode
string or null
Array of objects or null (InvoiceDetail)

A list of Invoice Details

Responses

Request samples

Content type
application/json

An Example Invoice.

{
  • "InvoiceNum": "12345678",
  • "InvoiceDt": "2026-01-29T00:00:00",
  • "InvoiceDueDt": "2026-02-28T00:00:00",
  • "PoNum": "7654321",
  • "PoCreateDt": "2026-01-29T00:00:00",
  • "InvoiceVendorNum": "100000",
  • "PayToVendorNum": null,
  • "Duns": "100000",
  • "CartonCount": 2,
  • "TermsType": "Net 30 days",
  • "InvoiceTermsDt": "2026-02-28T00:00:00",
  • "RetailerTermsDiscDt": "2026-02-28T00:00:00",
  • "RetailerDueDt": null,
  • "TermsDiscPct": null,
  • "TermsDiscDays": null,
  • "TermNetDays": 30,
  • "NetDueDt": "2026-02-28T00:00:00",
  • "DefAmtDue": null,
  • "PctInvPayable": null,
  • "MerchDol": null,
  • "NonMerchDol": null,
  • "Freight": 100,
  • "TermsDiscAmt": null,
  • "TotalInvAmt": 1500,
  • "NetAmtDue": 1500.88,
  • "PaymentDueDt": null,
  • "BolNum": "07200000000678901",
  • "ShipToLoc": "999",
  • "MarkForLoc": null,
  • "ProNum": "9898989898",
  • "TotalCartons": 2,
  • "ShipDt": "2026-01-29T00:00:00",
  • "DeptNum": "123",
  • "NumberOfLines": 2,
  • "TransactionType": null,
  • "PackSlip": null,
  • "ShipFromLoc": null,
  • "BillTo": null,
  • "RemitAddress1": null,
  • "RemitAddress2": null,
  • "RemitAddress3": null,
  • "RemitAddress4": null,
  • "RemitCity": null,
  • "RemitState": null,
  • "RemitZip": null,
  • "CountryCode": null,
  • "Fob": null,
  • "Uom": null,
  • "ReceivedDt": "2026-01-29T00:00:00",
  • "OriginalInvoiceNum": null,
  • "InterchangeSenderId": null,
  • "InterchangeReceiverId": null,
  • "GroupSenderId": null,
  • "GroupReceiverId": null,
  • "RawEdiIdentifier": null,
  • "RawEdiFileName": null,
  • "GroupControlNumber": null,
  • "InterchangeControlNumber": null,
  • "InterchangeReceiverIdQualifier": null,
  • "InterchangeSenderIdQualifier": null,
  • "TransactionControlNumber": null,
  • "TransactionTypeCode": null,
  • "EdiSentTs": null,
  • "Allowance": null,
  • "AllowanceAmt": null,
  • "AllowancePct": null,
  • "Charge": null,
  • "ChargeAmt": null,
  • "ChargePct": null,
  • "TermsOfSaleTypeCode": null,
  • "Details": [
    ]
}

Response samples

Content type
application/json
"Success"

Ocean Status

The SPS Commerce Visibility Ocean Status API allows Visibility customers to send a Container Status to Visibility. The ability to view the Ocean Container Status in Visibility keeps retailers up to date on the location of their goods and allows for informed logistics decisions.

Send a Ocean Container Status file

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.

Authorizations:
basic_auth
Request Body schema: application/json

The request body should contain JSON data representing a Ocean Container File.

file

Responses

Request samples

Content type
application/json
null

Response samples

Content type
application/json
"Success"

Po

The SPS Commerce Visibility PO API allows Visibility customers to send a Purchase Order to Visibility. The Purchase Order is the ultimate source of truth, documenting what was ordered, when, and by whom, along with numerous other optional fields.

Send a PO

This API endpoint receives JSON data representing a Purchase Order including all of its Item and Store information.

Access to this endpoint may differ based on user permissions.

Authorizations:
basic_auth
Request Body schema: application/json

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
Weight
number or null
RequestedArrivalTs
date-time or null
AppointmentTs
date-time or null
EdiOrderType
string or null
LocationName
string or null
VendorName
string or null
DeptDesc
string or null
Division
string or null
Array of objects or null (PoItem)

A list of PO Items

Responses

Request samples

Content type
application/json

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": [
    ]
}

Response samples

Content type
application/json
"Success"

Po Acknowledgement

The SPS Commerce Visibility PO Acknowledgement API allows Visibility customers to send a Purchase Order Acknowledgement to Visibility.

Send a Po Acknowledgement

This API endpoint receives JSON data representing a Po Acknowledgement, including all of its details.

Access to this endpoint may differ based on user permissions.

Authorizations:
basic_auth
Request Body schema: application/json

The request body should contain JSON data representing an Po Acknowledgement.

PoNum
required
string

PoNum is required

UniqueAddenda
string or null
CustCreateDt
any or null <date-time>
ReferenceNum
required
string
PoCreateDt
date-time or null
PoaDt
date-time or null
CurrencyCode
string or null
BillToCompany
string or null
ShipToCompany
string or null
OriginalCompany
string or null
Store
string or null
Comments
string or null
PoaStatus
string or null
VendorNum
string or null
EdiSentTs
date-time or null
GroupReceiverId
string or null
GroupSenderId
string or null
InterchangeReceiverId
string or null
InterchangeSenderId
string or null
GroupControlNumber
string or null
InterchangeControlNumber
string or null
TransactionControlNumber
string or null
RawEdiIdentifier
string or null
RawEdiFileName
string or null
InterchangeReceiverIdQualifier
string or null
InterchangeSenderIdQualifier
string or null
Array of objects or null (PoAcknowledgementDetail)

A list of PO Acknowledgment Details

Responses

Request samples

Content type
application/json

An Example Po Acknowledgement.

{
  • "PoNum": "1234567",
  • "PoCreateDt": "2025-11-07T00:00:00",
  • "ReferenceNum": "4321",
  • "PoaDt": "2025-11-07T00:00:00",
  • "CurrencyCode": null,
  • "BillToCompany": null,
  • "ShipToCompany": "ACME Company",
  • "OriginalCompany": null,
  • "Store": "888",
  • "Comments": null,
  • "PoaStatus": "AD",
  • "VendorNum": null,
  • "EdiSentTs": null,
  • "GroupReceiverId": null,
  • "GroupSenderId": null,
  • "InterchangeReceiverId": null,
  • "InterchangeSenderId": null,
  • "GroupControlNumber": null,
  • "InterchangeControlNumber": null,
  • "TransactionControlNumber": null,
  • "RawEdiIdentifier": null,
  • "RawEdiFileName": null,
  • "InterchangeReceiverIdQualifier": null,
  • "InterchangeSenderIdQualifier": null,
  • "Details": [
    ]
}

Response samples

Content type
application/json
"Success"

Po Change

The SPS Commerce Visibility PO Change API allows Visibility customers to send a Purchase Order Change to Visibility.

Send a PO Change

This API endpoint receives JSON data representing a Purchase Order Change including all of its Detail information.

Access to this endpoint may differ based on user permissions.

Authorizations:
basic_auth
Request Body schema: application/json

The request body should contain JSON data representing a PO Change.

PoNum
string
UniqueAddenda
string
ChangeType
string or null
DeptNum
string or null
DeptDesc
string or null
VendorNum
string
VendorName
string or null
ShipToNum
string or null
LocationName
string or null
ShipStartDate
date-time or null
ShipStopDate
date-time or null
PoCreateDate
date-time or null
PoApprovalDate
date-time or null
PoCancelDate
string or null
CancelByDate
date-time or null
EdiSentDate
date-time or null
NewStoreFlag
string or null
AdvertisedDate
date-time or null
Fob
string or null
BillType
string or null
TotalUnits
number or null
BuyerNum
string or null

Alternate for MerchantNum. If provided, used as MerchantNum.

MerchantNum
string or null
MerchantName
string or null
Terms
string or null
Division
string or null
Version
string or null
PoComments
string or null
UserDef1
string or null
UserDef2
string or null
UserDef3
string or null
Weight
number or null
PocFlag
string or null
PocType
string or null
EdiOrderType
string or null
ChangeDate
date-time or null
ChangeReason
string or null
CustomerOrderNum
string or null
OrderStatus
string or null
ParentCompany
string or null
RequestedArrivalTs
date-time or null
PoTotalCost
number or null
XrefPoNum
string or null
InterchangeControlNumber
string or null
GroupControlNumber
string or null
InterchangeSenderID
string or null
InterchangeReceiverID
string or null
GroupSenderID
string or null
GroupReceiverID
string or null
TransactionControlNumber
string or null
RawEdiIdentifier
string or null
RawEdiFileName
string or null
InterchangeReceiverIdQualifier
string or null
InterchangeSenderIdQualifier
string or null
Array of objects or null (PoChangeDetail)

A list of PO Change Details

Responses

Request samples

Content type
application/json

An Example PO Change.

{
  • "PoNum": "4500123456",
  • "UniqueAddenda": "A1",
  • "ChangeType": "U",
  • "DeptNum": "0123",
  • "DeptDesc": "Health",
  • "VendorNum": "V000123",
  • "VendorName": "ACME SUPPLY",
  • "ShipToNum": "1001",
  • "LocationName": "Main DC",
  • "ShipStartDate": "2026-06-01T00:00:00Z",
  • "ShipStopDate": "2026-06-15T00:00:00Z",
  • "PoCreateDate": "2026-05-25T10:30:00Z",
  • "PoApprovalDate": "2026-05-26T08:15:00Z",
  • "PoCancelDate": null,
  • "CancelByDate": "2026-05-31T00:00:00Z",
  • "EdiSentDate": "2026-05-26T09:00:00Z",
  • "NewStoreFlag": "N",
  • "AdvertisedDate": "2026-06-05T00:00:00Z",
  • "Fob": "ORIGIN",
  • "BillType": "REG",
  • "TotalUnits": 1200,
  • "BuyerNum": "B7788",
  • "MerchantNum": "M7788",
  • "MerchantName": "Jane Buyer",
  • "Terms": "NET30",
  • "Division": "CVS",
  • "Version": "2",
  • "PoComments": "PO Change for qty updates",
  • "UserDef1": "UD1",
  • "UserDef2": "UD2",
  • "UserDef3": "UD3",
  • "Weight": 145.5,
  • "PocFlag": "Y",
  • "PocType": "01",
  • "EdiOrderType": "NE",
  • "ChangeDate": "2026-05-27T12:00:00Z",
  • "ChangeReason": "Qty correction",
  • "CustomerOrderNum": null,
  • "OrderStatus": null,
  • "ParentCompany": null,
  • "RequestedArrivalTs": null,
  • "PoTotalCost": null,
  • "XrefPoNum": null,
  • "InterchangeControlNumber": null,
  • "GroupControlNumber": null,
  • "InterchangeSenderID": null,
  • "InterchangeReceiverID": null,
  • "GroupSenderID": null,
  • "GroupReceiverID": null,
  • "TransactionControlNumber": null,
  • "RawEdiIdentifier": null,
  • "RawEdiFileName": null,
  • "InterchangeReceiverIdQualifier": null,
  • "InterchangeSenderIdQualifier": null,
  • "Details": [
    ]
}

Response samples

Content type
application/json
"Success"

Receipt

The SPS Commerce Visibility Receipt API allows Visibility customers to send a Receipt data to Visibility.-

Send a Receipt

This API endpoint receives JSON data representing a Receipt including all of its detail information.

Access to this endpoint may differ based on user permissions.

Authorizations:
basic_auth
Request Body schema: application/json

The request body should contain JSON data representing an Receipt.

ReceiptNum
string
ReceiptDate
date-time
PoNum
string
PoUniqueAddenda
string or null
Scac
string or null
ProNum
string or null
TrailerNum
string or null
CartonCount
number or null
Area
string or null
Status
string or null
ReceiptSiteNum
string or null
TotalUnits
number or null
BolNum
string or null
CompleteDate
date-time or null
PickupDate
date-time or null
ArrivalDate
date-time or null
UnloadDate
date-time or null
ReceiptType
string or null
Array of objects or null (ReceiptDetail)

A list of Receipt Details

Responses

Request samples

Content type
application/json

An Example Receipt.

{
  • "ReceiptNum": "124578",
  • "ReceiptDate": "2024-12-09T00:00:00",
  • "PoNum": "234567",
  • "PoUniqueAddenda": "20241203",
  • "Scac": "FDEG",
  • "ProNum": "34543222",
  • "TrailerNum": "19828",
  • "CartonCount": 1,
  • "Area": null,
  • "Status": "Complete",
  • "ReceiptSiteNum": "1002",
  • "TotalUnits": 10,
  • "BolNum": "898786",
  • "CompleteDate": "2024-12-08T00:00:00",
  • "PickupDate": "2024-12-07T00:00:00",
  • "ArrivalDate": "2024-12-06T00:00:00",
  • "UnloadDate": null,
  • "ReceiptType": "PO",
  • "Details": [
    ]
}

Response samples

Content type
application/json
"Success"

Receipt Summary

The SPS Commerce Visibility Receipt Summary API allows Visibility customers to send a summarized Receipt data to Visibility. The Receipt Summary aggregates data by Receipt and PO.

Send a Receipt Summary

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.

Authorizations:
basic_auth
Request Body schema: application/json

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

Responses

Request samples

Content type
application/json

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
}

Response samples

Content type
application/json
"Success"

Routing Request

The SPS Commerce Visibility Routing Request API allows Visibility customers to send a Routing Request to Visibility. 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.

Send a Routing Request

This API endpoint receives JSON data representing a Routing Request.

Access to this endpoint may differ based on user permissions.

Authorizations:
basic_auth
Request Body schema: application/json

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

Responses

Request samples

Content type
application/json

An Example Routing Request.

{
  • "$ref": "../components/examples/routing-request.yaml"
}

Response samples

Content type
application/json
"Success"

Shipment

The SPS Commerce Visibility Shipment API allows Visibility customers to send a Shipment to Visibility. The Shipment describes the current state of the shipment from origin to destination. The events can range from tracking started to delivered.

Send a Shipment

This API endpoint receives JSON data representing a Shipment including all of its Event information.

Access to this endpoint may differ based on user permissions.

Authorizations:
basic_auth
Request Body schema: application/json

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

Responses

Request samples

Content type
application/json

An Example Shipment.

{
  • "$ref": "../components/examples/shipment.yaml"
}

Response samples

Content type
application/json
"Success"

Shipment Billing Notice

The SPS Commerce Visibility Shipment Billing Notice API allows Visibility customers to send a Shipment Billing Notice to Visibility.

Send a Shipment Billing Notice

This API endpoint receives JSON data representing a Shipment Billing Notice, including all of its order details.

Access to this endpoint may differ based on user permissions.

Authorizations:
basic_auth
Request Body schema: application/json

The request body should contain JSON data representing a Shipment Billing Notice.

ShipmentNoticeNumber
string

ShipmentNoticeNumber is required

InterchangeSenderId
string or null
InterchangeSenderIdQualifier
string or null
InterchangeReceiverId
string or null
InterchangeReceiverIdQualifier
string or null
GroupSenderId
string or null
GroupReceiverId
string or null
GroupControlNumber
string or null
InterchangeControlNumber
string or null
TransactionControlNumber
string or null
RawEdiIdentifier
string or null
RawEdiFileName
string or null
EdiSentTs
date-time or null
ShipNoticeDt
date-time or null
ASNStructureCode
string or null
TransactionPurpose
string or null
ShipmentQuantity
number or null
ShipmentQuantityUom
string or null
ShipToLocationNumber
string or null
ShipToLocationName
string or null
ShipFromLocationNumber
string or null
ShipFromLocationName
string or null
TotalAmount
number or null
TotalQtyInvoiced
number or null
TotalQtyInvoicedUom
string or null
Array of objects or null (ShipmentBillingNoticeOrder)

A list of Shipment Billing Notice Orders

Responses

Request samples

Content type
application/json

An Example Shipment Billing Notice.

{
  • "ShipmentNoticeNumber": "SBN-20220920-001",
  • "InterchangeSenderId": "IS-004",
  • "InterchangeSenderIdQualifier": "01",
  • "InterchangeReceiverId": "IR-003",
  • "InterchangeReceiverIdQualifier": "01",
  • "GroupSenderId": "GS-002",
  • "GroupReceiverId": "GR-001",
  • "GroupControlNumber": "GCN-10001",
  • "InterchangeControlNumber": "ICN-20002",
  • "TransactionControlNumber": "TCN-30003",
  • "RawEdiIdentifier": "857",
  • "RawEdiFileName": "857_20220920_001.edi",
  • "EdiSentTs": "2022-09-20T14:30:00",
  • "ShipNoticeDt": "2022-09-20T00:00:00",
  • "ASNStructureCode": "0001",
  • "TransactionPurpose": "00",
  • "ShipmentQuantity": 7,
  • "ShipmentQuantityUom": "EA",
  • "ShipToLocationNumber": "01100",
  • "ShipToLocationName": "DC Fort Worth",
  • "ShipFromLocationNumber": "76155",
  • "ShipFromLocationName": "Vendor Warehouse",
  • "TotalAmount": 358.11,
  • "TotalQtyInvoiced": 7,
  • "TotalQtyInvoicedUom": "EA",
  • "Orders": [
    ]
}

Response samples

Content type
application/json
"Success"

Shipment Delivery Status

The SPS Commerce Visibility Shipment Delivery Status API allows Visibility customers to send a Shipment Delivery Status to Visibility. 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.

Send a Shipment Delivery Status

This API endpoint receives JSON data representing an EDI 214 or Shipment Delivery Status.

Access to this endpoint may differ based on user permissions.

Authorizations:
basic_auth
Request Body schema: application/json

The request body should contain JSON data representing an Shipment Delivery Status.

ShipmentNum
string
BolNum
string
Scac
string or null
StatusCode
string or null
StatusDate
string
Address1
date-time or null
Address2
date-time or null
City
date-time or null
State
string or null
Zip
string or null
CountryCode
string or null
StatusUser
string or null
DetailCreateDate
date-time or null
OriginAddress1
string or null
OriginAddress2
string or null
OriginCity
string or null
OriginState
string or null
OriginZip
string or null
OriginCountryCode
string or null
DestAddress1
string or null
DestAddress2
string or null
DestCity
string or null
DestState
string or null
DestZip
string or null
DestCountryCode
string or null

Responses

Request samples

Content type
application/json

An Example Shipment Delivery Status.

{
  • "ShipmentNum": "3666874JR",
  • "BolNum": "M999018-JR",
  • "Scac": "CNWY",
  • "StatusCode": "X4",
  • "StatusDate": "02/16/2023 02:11",
  • "Address1": "",
  • "Address2": "",
  • "City": "Fontana",
  • "State": "CA",
  • "Zip": "",
  • "CountryCode": "US",
  • "StatusUser": "AlbreyMorelock",
  • "OriginAddress1": "3300 TCHULATECH DR",
  • "OriginAddress2": "",
  • "OriginCity": "MEMPHIS",
  • "OriginState": "TN",
  • "OriginZip": "38118",
  • "OriginCountryCode": "USA",
  • "DestAddress1": "LANDAIR/MCX % Landair Distribution",
  • "DestAddress2": "151 CARTER BEST RD UNIT 5",
  • "DestCity": "Warsaw",
  • "DestState": "NC",
  • "DestZip": "28398",
  • "DestCountryCode": "USA",
  • "DetailCreateDate": "02/15/2023 21:57"
}

Response samples

Content type
application/json
"Success"

Site

The SPS Commerce Visibility Site API allows Visibility customers to send a Site to Visibility. 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.

Send a Site

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.

Authorizations:
basic_auth
Request Body schema: application/json

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
OperationalStatus
string or null
ClusterType
string or null

Responses

Request samples

Content type
application/json

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,
  • "OperationalStatus": "Open",
  • "ClusterType": "MAIN STORE"
}

Response samples

Content type
application/json
"Success"

Store Scan

The SPS Commerce Visibility Store Scan API allows Visibility customers to send a Store Scan to Visibility. Since this scanning event is at the final destination, it signals the final status for those goods.

Send a Store Scan

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.

Authorizations:
basic_auth
Request Body schema: application/json

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 Receiving or Transfer

UserName
string or null
DocCreateDate
date-time or null
DocUpdateDate
date-time or null
TfIndicator
string or null

Responses

Request samples

Content type
application/json

An Example Store Scan.

{
  • "$ref": "../components/examples/store-scan.yaml"
}

Response samples

Content type
application/json
"Success"

Send a Store Scan File

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.

Authorizations:
basic_auth
Request Body schema: application/json

The request body should contain JSON data representing an Store Scan.

file

Responses

Request samples

Content type
application/json
null

Response samples

Content type
application/json
"Success"

Trouble

The SPS Commerce Visibility Trouble Summary API allows Visibility 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.

Send a Trouble Summary

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.

Authorizations:
basic_auth
Request Body schema: application/json

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

Responses

Request samples

Content type
application/json

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
}

Response samples

Content type
application/json
"Success"

WMS

The SPS Commerce Visibility WMS Detail API allows Visibility customers to send Warehouse Management System detail data to Visibility. The fields available for query include everything from the Site number to pallet and Item numbers.

Send a WMS Detail

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.

Authorizations:
basic_auth
Request Body schema: application/json

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 FLOW or STOW or INVENTORY

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

Responses

Request samples

Content type
application/json

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
}

Response samples

Content type
application/json
"Success"

Send a WMS Detail file

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.

Authorizations:
basic_auth
Request Body schema: application/json

The request body should contain JSON data representing an WMS Detail file.

file

Responses

Request samples

Content type
application/json
null

Response samples

Content type
application/json
"Success"

Vendor

The SPS Commerce Visibility Vendor API allows Visibility customers to send robust Vendor or Supplier data to Visibility, including addresses, active (y/n), type, number, and more.

Send a Vendor

This API endpoint receives JSON data representing a Vendor or Supplier.

Access to this endpoint may differ based on user permissions.

Authorizations:
basic_auth
Request Body schema: application/json

The request body should contain JSON data representing an Vendor.

VendorNum
string
Name
string
Active
string

Value should be either Y or N

Ein
string or null
Duns
string or null
CertifiedFlag
string

Value should be either Y or N

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
VendorStatus
string or null
VendorStatusEffectiveDate
date-time or null

Responses

Request samples

Content type
application/json

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",
  • "VendorStatus": "InProgress",
  • "VendorStatusEffectiveDate": "2022-09-17T00:00:00"
}

Response samples

Content type
application/json
"Success"