Supplier RESTFul API (B2BPRODWEB5)

PLEASE NOTE THAT THIS TEST UTILITY IS MERELY A TOOL PROVIDED AS AN INITIAL INTRODUCTION TO THE WEB SERVICES CURRRENTLY AVAILABLE TO SHOPRITE SUPPLIERS AS PART OF THE RESTFUL API

Click anywhere in the body of this message to hide this User Notification

THIS HELP PAGE/TEST FUNCTIONALITY IS AVAILABLE TO AND INTENDED FOR DEVELOPERS WANTING TO CONSUME THE SERVICES ON BEHALF OF SUPPLIER TO USE DURING DEVELOPMENT AND CAN BE USED TO MAKE ALL TYPES OF REQUESTS INCLUDED IN THE RESTFUL API TO BOTH QA AND PRODUCTION ENVIRONMENTS

THE INTENTION OF THIS HELP PAGE/TOOL IS TO HELP DEVELOPERS AND/OR FACILITATE THE DEVELOPMENT PROCESS OF EXTERNAL INTERFACES TO OUR RESTFUL SERVICES BY PROVIDING THIS CENTRAL, GRAPHICAL AND EASY TO USE INTERACTION POINT WHERE DEVELOPERS/POTENTIAL USERS CAN BECOME FAMILIAR WITH THE INTERFACE OF OUR RESTFUL SERVICES, ESPECIALLY WITH RESPECT TO THE AREAS/ASPECTS BELOW WITHOUT HAVING TO BE CONCERNED WITH ANY TECHNICAL CONCERNS SUCH AS CODE SYNTAX, ETC:

FAMILIARIZING WITH SYNTAX OF THETHE RESTFUL PATTERN FOLLOWED BY THESE SERVICES
ENSURING USERNAME/PASSWORD CREDENTIALS ARE AUTHENTIC/AND HAVE ADEQUATE PERMISSIONS TO ACCESS THE VARIOUS SERVICES
GETTING A FEEL FOR THE FORMAT AND CONTENT TYPES ALLOWED WHEN SENDING AND RECEIVING DATA
WITH FAMILIARIZING THEMSELVES WITH THE VERY BASIC PRINCIPLES SURROUNDING
CONSUMING THE SHOPRITE RESTFUL SUPPLIER SERVICES

PLEASE ENSURE CONFORMITY TO THE OFFICIAL SPECIFICATIONS AS OUTLINED IN OUR OFFICIAL IMPLEMENTATION GUIDE, ONCE YOU START TO MAKE REQUESTS TO OUR RESTFUL SERVICES DIRECTLY. THIS IS ESPECIALLY IMPORTANT WITH RESPECT TO:

THE URL'S TO WHICH REQUESTS ARE DIRECTED
REQUIRED AUTHORIZATION HEADERS CONTAINING AUTHENTICATION/AUTHORIZATION DETAILS
REQUESTS TO THE OFFICE URLS (https://externalserviceS/.....) WILL NOT ACCEPT USERNAME AND PASSWORD INFORMATION (ENCRYPTED OR UNENCRYPTED) AS URL PARAMETERS, IT NEEDS TO BE SENT ENCRYPTED AS AN AUTHORIZATION HEADER AS PER THE SPECIFICATION - PLEASE SEE THE THE IMPLEMENTATION GUIDE FOR DETAILED INFORMATION (https://b2b.shopriteholdings.co.za/B2BWebAPISupplierServices/Home/About)

VendorOrder

Contoller exposing CRUD functionality on Orders for a particular Vendor. Authentication and Authorization happens on a per call basis. Login Credentials (Username and Password) are expected as string Parameters with every Request

API	Description
GET VendorOrder	Download new Orders for Vendor (Max per request may vary)
PUT VendorOrder	Acknowledge/Reset Orders for Vendor
POST VendorOrder	Acknowledge/Reset Orders for Vendor by Order_HeaderID

VendorClaim

Contoller exposing CRUD functionality on Claims for a particular Vendor. Authentication and Authorization happens on a per call basis. Login Credentials (Username and Password) are expected as string Parameters with every Request

API	Description
GET VendorClaim	Download New Claims for a Vendor (Max per request may vary)
PUT VendorClaim	Acknowledge/Reset Claims for Vendor
POST VendorClaim	Acknowledge/Reset Claims for Vendor by Claim_HeaderID

VendorASN

Contoller exposing CRUD functionality on ASN for a particular Vendor. Authentication and Authorization happens on a per call basis. Login Credentials (Username and Password) are expected as string Parameters with every Request

API	Description
GET VendorASN	Returns the first downloadable ASNs for a given Supplier
POST VendorASN	Accepts an ASN record for a given Supplier
PUT VendorASN	Acknowledge/Reset ASN's for Vendor

VendorRebate

Contoller exposing CRUD functionality on Rebates for a particular Vendor. Authentication and Authorization happens on a per call basis. Login Credentials (Username and Password) are expected as string Parameters with every Request

API	Description
GET VendorRebate	Returns the first downloadable Rebates for a given Supplier
PUT VendorRebate	Acknowledge/Reset Rebate's for Vendor

VendorInvoice

Contoller exposing CRUD functionality on Invoices for a particular Vendor. Authentication and Authorization happens on a per call basis. Login Credentials (Username and Password) are expected as string Parameters with every Request

API	Description
GET VendorInvoice	Returns the first downloadable Invoices for a given Supplier
GET VendorInvoice	Returns the first N downloadable Invoices for a given Supplier
POST VendorInvoice	Accepts an invoice record for a given Supplier

B2BInvoice

API	Description
GET B2BInvoice	Returns the first downloadable Invoices for a given Supplier
GET B2BInvoice	Returns the first N downloadable Invoices for a given Supplier
POST B2BInvoice	Accepts an invoice record for a given Supplier. Used by Invoice Capture Screens as part of B2B project.