Jump to Content

v1.0

API Reference

v1.0API Reference

API Usage

Introduction
Authentication
Identifying Objects
- Get Requests
- Send Requests
API Response Codes
Setting Override
Throttling
Pagination
Response Metadata

Order

Orders Introduction
Orders Schema
Orders Sample Data
Orders Endpoint(s)

Acknowledgement

Acknowledgment Introduction
Acknowledgment Schema
Acknowledgment Sample Data
Acknowledgment Endpoint(s)
- Send Acknowledgement

Shipment

Shipment Introduction
- Usage Notes
Shipments Schema
Shipment Sample Data
Get Ship Request (940)
- Get Ship Request (940) Schema
- Ship Request Sample Data
Send (Create/Update) Shipment
Get Shipment
Shipments Endpoint(s)
- Get Shipmentsget
- Send Shipmentspost
Carton Numbering
Generate Shipping Documents from Spring
Auto Delivery of Shipping Documents

Invoice

Invoice Introduction
Invoices Schema
Invoice Sample Data
Invoice Endpoint(s)
- Get Invoicesget
- Send Invoicespost

Catalog

Product Catalog Intro Doc
Catalogs Schema
Catalog Sample Data
Catalog Endpoint(s)
- Get Productsget
- Send Productspost

Inventory

Product Inventory
Inventory Schema
Inventory Sample Data
Inventory Endpoint(s)
- Get Inventoryget
- Send Inventorypost

Credit Debit Notice

Credit Debit Notice Introduction
Credit Debit Notice Endpoint(s)

Org Address

Org Address Introduction
Org Address Endpoint(s)

Selling Report

Selling Report Introduction
Selling Report Endpoint(s)

Merchandise Return

Merchandise Return Introduction
Merchandise Return Endpoint(s)

Payment Remittance

Payment Remittance Introduction
Payment Remittance Endpoint(s)

Stock Transfer Info

Stock Transfer Info Introduction
Stock Transfer Info Endpoint(s)

Appendix

Appendix I – XSD List
Appendix II – Full List of API Endpoints
Appendix III – D2C Shipping, carrier, SCAC, ship method
Appendix IV - Field List & Mandatory Fields by Retailer
Appendix V - EDI Specifications

Powered by

Send Requests

POST endpoints are used for creating new resources and updating existing resources. To update an existing object, the object must be identified in the payload.