Updated API Documentation

More suppliers are connecting their ERP and warehouse systems directly to Procurant, and we've heard that the old API specs were hard to follow. So, we've rewritten the full set. The new documentation is in the Supplier Information Center, next to the EDI X12 documents, for reference and download.

What's included

Here is a quick summary of what's included:

• Getting Started & Authentication: How Procurant's APIs work, how the documents move from PO to payment, and how to get and use a bearer token. It also lists every supplier-facing endpoint, the test and production environments, and who to contact for credentials.
• Purchase Order & PO Change JSON Reference: A field-by-field guide to the 850 (new PO) and 860 (PO Change) documents Procurant sends you. It also shows how to tell a change from a new order.
• ASN API Specification: How to send an Advance Ship Notice: what shipped, when, from where, and the lot-level traceability detail buyers expect.
• Invoice API Specification: How to bill a buyer for a shipped or received order. It covers the payment-term and bill-to/remit-to fields an invoice needs before it can be paid.
• Order Acknowledgment API Specification: How to confirm the quantities, pricing and substitutions you can fulfill before you ship.
• EDI API Error Reference Guide (companion): HTTP status codes, error codes, what each one means and how to fix it, plus sample error responses and troubleshooting steps.

What's different from the previous versions

• Clear requirement labels: Every field is tagged API Requirement, Business Requirement, Conditional or Optional. You can tell right away which fields will get a call rejected and which ones matter to your buyer even when the API accepts the call without them.
• Same layout in every spec: Each document has a quick-reference table, a shared location-block pattern for buyer, ship-to, supplier and the other roles, conditional field rules, business rules and a sample request.
• Fields seen in production: Each spec has a section listing fields we've seen suppliers send in production that aren't in the formal spec yet.
• Standardized URLs: The mixed placeholder URLs in earlier versions now follow one pattern across all APIs.

Replacing the earlier specs

These documents replace the earlier Supplier API specifications, including EDI Supplier Inbound API Specs, the ASN, Invoice and Order Ack Supplier API Specifications, and the 850/860 JSON Standard. If you've saved copies of the old versions, please download the new set.

Just getting started with an API integration?

Start with the Getting Started document, then contact your Procurant implementation contact. They'll set up your trading-partner record and send you test and production credentials. Please test your integration end to end in the test environment, including error cases, before you send live documents.

As always, we will stay close to our retail partners and share what we can with all suppliers here in the Hubbub and more broadly across the Supplier Information Center.