How To Tie Into Well ProZ Using API (for Developers)

The Wellproz API is designed to allow users to interact with Well ProZ using RESTful architecture.

Authorization

Basic authorization required. The username and password provided by Well ProZ should be put into the headers.

Base URL

API Production URL

• https://api2.wellproz.com/v1

API Stage URL

• https://api2.wellproz.com/v1/staging

Update Tracking Number

POST

• Description: Update the tracking number of an order

Request Body

orderNumberId	Long	The id of the order that will be updated is the tracking number. The orderNumberId should be received via our webhook.
trackingNumber	String	The tracking number from the delivery company.

Example POST

Request	POST /api/tracking-number Content-Type: application/json Authorization: Basic
Request Body	{     "orderNumberId": 133,     "trackingNumber": "us123" }
Response	success, 200

Error Handle

400	Bad request, please check your body variable name and format
422	Incorrect input content

Webhook

Description: We will send the POST request with the order info to the URL that the user specifies

Response Values

VendorId	Long
ItemList	String	String sku: Product sku, String name: Product name, Int      quantity: Product quantity
Address		String FName - First Name String LName - Last Name String Address1-  Address line 1 String Address2- Address line 2 String City String State-Two letter state abbreviation String Zip
OrderNumberId	Int	The id of the order that will be updated is the tracking number. The orderNumberId should be received via our webhook.

Response Example

{ vendorId: 04, Body{ itemList: [{“sku”: 00001,                           “ name”: “abcCapsule”,                            “quantity”: 2}],            address: { “FName”: “Bil”l,                             “Lname”: “Gates”,                            “ Address1”: “1234 Soft st”                            “ Address2”:                             “City”: “Seattle”,                             “State”: “WA”                             “Zip”: “98101”}             “orderNumberId”: 193}