Customer
Customer Controller
| API | Description |
|---|---|
| GET API/Customer/CartDetails?action={action}&productId={productId}&quantity={quantity} |
Manage User Cart : Action : Get/Add/Quantity/Delete/CountThis Get Action is used for the following: 1. To retrieve Cart items for the Logged-In User. 2. To add items to User Cart. 3. To update item quantity in the User Cart. 4. To add a Subscription plan to an item in the cart. 5. To add a Start Date to a subscription plan for an item in the user cart. |
| GET API/Customer/CheckoutDetails?action={action} |
Get Order Checkout Details from the User Cart. |
| GET API/Customer/PlaceOrderDetails?action={action} |
Get User Cart Details to place an Order. |
| POST API/Customer/Order?action={action} |
Manage Orders: Add/Place or Update or Cancel an Order. Required parameter(s) for Action(s): "Add" : OrderDetails {ProductId,Quantity,UnitPrice,SubscriptionPlanId,SubscriptionStartDate, SubscriptionEndDate,SubscriptionDates} "Confirm" : OrderId. "OrderPickedUp : OrderId. "Delivered" : OrderId. "Cancel" : OrderId. "Return" : OrderId. |
| POST API/Customer/Wallet?action={action} |
Manage Payment Wallet Details [Required]: Expected Value(s): "Create","Success","Error". Required parameter(s) for Action(s): "Create" : Payment Object { Amount,TransactionType,TransactionStatus,PayOrderId,Attempts,ReceiptKey,Currency,Name,Email,Phone} "Success" : Payment Object { Amount,TransactionStatus,TransactionType,PayOrderId,PayPaymentId,PaymentSignature,ReceiptKey,Currency,Name,Email,Phone} "Error" : Payment Object { Amount,Currency,ReceiptKey,PayOrderId,PayPaymentId,TransactionStatus,TransactionType,ErrorCode,ErrorDescription,ErrorReason,ErrorSource,ErrorStep,Name,Email,Phone} |
| POST API/Customer/Subscription?action={action} |
Manage Subscription Details Required parameter(s) for Action(s): "Cancel" : objSubscription{SubscriptionId, StartDate, EndDate} "AssignDeliveryBoy" : objSubscription{SubscriptionId, SubscriptionsXML} "Vacation" : objSubscription{SubscriptionId, StartDate, EndDate} "CancelVacation" : objSubscription{SubscriptionId, Comments} |
| POST API/Customer/SearchOrders?action={action}&userId={userId}&loginId={loginId} |
Search Customers Order(s). Required parameter(s) for Action(s): "GetOrders" : OrderSearchEntity{ OrderNumber, OrderStatusId, DeliveryBoyId, PinCode, Product, OrderDateFrom, OrderDateTo, SubscriptionOrders} "GetOrderDetails" : OrderSearchEntity{ OrderId,} "TrackOrderDetails" : OrderSearchEntity{ OrderId} |
| POST API/Customer/SearchSubscriptions?action={action}&userId={userId}&loginId={loginId} |
Search the database for existing Subscriptions Required parameter(s) for Action(s): "GetSubscriptions" : SubscriptionSearchEntity{SubscriptionNumber,SubscriptionStatusId,SubscriptionPlanId, PinCode, Product,DeliveryBoyId} "GetSubscriptionDetails" : SubscriptionSearchEntity{SubscriptionId} |
| POST API/Customer/CheckPricing |
This is the Pricing API which provides information on domestic shipment rates from one pincode to another across various courier partners. |
| GET API/Customer/PlacePickrrOrder?orderId={orderId}&isReverseOrder={isReverseOrder} |
This api will be used to place orders on Pickrr platform. |
| GET API/Customer/CancelPickrrOrder?tracking_id={tracking_id} |
This API will be used to cancel any orders that have been placed with pickrr. Orders can only be cancelled if they haven't been already dispatched to the courier partner. |
| POST API/Customer/ManageServieZipCodes?action={action} |
Add new Zipcode (or) if the zipcode is existing it will add requestcount with increment 1 |
| POST API/Customer/CreatePaymentOrderId |
Create Payment Order Id |
| GET API/Customer/ProcessAndGenerateSubscriptionOrders |
Process And Generate Subscription Orders |
| GET API/Customer/TrackingPickrrOrder?tracking_id={tracking_id} |
This is the tracking api for Pickrr and gives the entire tracking result and history for orders placed through Pickrr. |
| GET API/Customer/UpdatePickrrOrderStatus |
Update Pickrr Order Status |
| POST API/Customer/ManageDashBoardGallery?action={action} |
No documentation available. |
Authentication
API Authentication Controller
| API | Description |
|---|---|
| POST API/Authentication/VerifyDuplicateUser |
VerifyDuplicateUser: Email and MobileNumber are the required parameters to verify if the user is a registerd user or duplicate user |
| GET API/Authentication/SendOTP?phoneNumber={phoneNumber}&otpType={otpType} |
SendOTP: PhoneNumber is the manditory parameter to send an OTP to the User |
| POST API/Authentication/VerifyOTPAndSignUp |
Verify OTP And SignUp User: To verify OTP and Signup for a User FirstName, LastName, Email, MobileNumber are mandatory parameters |
| GET API/Authentication/VerifyOTP?phone={phone}&otp={otp}&otpType={otpType} |
Verify OTP: Send OTP and MobileNumber to verify OTP |
| GET API/Authentication/AuthenticateUser?loginId={loginId}&password={password} |
Authenticate User by using loginId and Password |
| GET API/Authentication/Menu?userId={userId} |
Get Menu Details By User If userId = 0 default menu will load |
| POST API/Authentication/VerifyOTPAndResetPassword |
Verify OTP: Send OTP and MobileNumber and new password to verify OTP and reset password |
| GET API/Authentication/SendResetPasswordOTP?phoneNumber={phoneNumber} |
SendResetPasswordOTP : PhoneNumber is the manditory parameter to send an OTP to the User |
FileUpload
File Upload Controller
| API | Description |
|---|---|
| POST API/FILEUPLOAD/FileUpload?fileType={fileType}&isTempFolder={isTempFolder}&fileNameWithExtn={fileNameWithExtn} |
File Upload |
User
User Controller
| API | Description |
|---|---|
| GET API/User/UserProfile |
Get User Profile Details: To get userprofile details |
| POST API/User/UpdateProfile |
Update User Profile: UserId,LoginId,FirstName,LastName are the required parameters to update User Profile |
| GET API/User/InactivateUser?userId={userId}&deleteData={deleteData} |
Delete User(Inactivate): UserId is the mandatory to Inactivate an User |
| GET API/User/ActivateUser?userId={userId} |
Activate User: UserId is the mandatory to Activate an User |
| GET API/User/UpdateProfileImage?imageName={imageName} |
Update User Profile Image: UserId and ProfileImage is the required parameter to Update User Profile Image |
| POST API/User/UpdatePassword |
Update Password (Change Password) NewPassword and OldPassword are the required parameters to update Password |
| GET API/User/DeliveryAddresses?userDeliveryAddressId={userDeliveryAddressId} |
Get User Delivery Addresses: If userDeliveryAddressId = 0 to get user delivery Address |
| POST API/User/DeliveryAddress?action={action} |
Manage User Delivery Addresses Action : Add/Update |
| GET API/User/DeleteDeliveryAddress?userDeliveryAddressId={userDeliveryAddressId} |
Delete User Delivery Address: UserDeliveryAddressId is the required parameter to delete delivery Address |
| GET API/User/Users?action={action}&userId={userId} |
Get All Users |
| POST API/User/User?action={action} |
Add/ Update User |
| GET API/User/Wallet?action={action} |
Wallet Details |
| POST API/User/RoleApplicationActions?action={action} |
No documentation available. |
Product
Product Controller
| API | Description |
|---|---|
| GET API/Product/Products?action={action}&productId={productId}&categoryId={categoryId} |
Get Product Details Action : Get/GetDetails |
| POST API/Product/Product?action={action} |
Manage Product Action : Add/AddProductImage/DeleteProductImage/Update/DeleteRequired parameter(s) for Action(s):Add : objProduct{ProductName/ProductDescription/ProductImage/Quantity/UOM/UnitPrice, ProductCategory/AvailabilityCount/SubscriptionAvailable}.AddProductImage : ProductId/ProductName/ProductDescription/ProductImage.DeleteProductImage : ProductImageId.SetDefaultProductImage : ProductId/ProductImageId/DefaultProductImage.Update : ProductId/ProductName/ProductDescription/Quantity/UOM/ProductCategory/UnitPrice/AvailabilityCount/SubscriptionAvailable.Delete : ProductIdActivate : ProductIdGet : None.GetAll : None.GetDetails : ProductId |
| GET API/Product/LikeUnlike?action={action}&productId={productId} |
Like (Or) Unlike a Product Action : Like/Unlike Required parameter(s) for Action(s): "Like" : @ProductId "Unlike" : @ProductId |
| GET API/Product/ProductCategories?action={action}&categoryId={categoryId} |
No documentation available. |
| POST API/Product/ProductCategory?action={action} |
No documentation available. |
| GET API/Product/RechargeCoupons?action={action}&RechargeCouponId={RechargeCouponId} |
No documentation available. |
| POST API/Product/RechargeCoupon?action={action} |
No documentation available. |
Common
Common Controller
| API | Description |
|---|---|
| GET API/Common/BrownCowInfo?action={action} |
Get Brown Cow Info Like Blogs/Vlogs/Gallery/DashboardGallery/DashboardInfo/MilkJourney |
| GET API/Common/MasterData?action={action} |
Getting Master Data Action : City/State/Country/UOM/Roles/DeliveryBoys/OrderStatus/DBOrderStatus/SubscriptionPlan/SubscriptionsAvailable/SubscriptionStatus |
| POST API/Common/Review?action={action} |
Manage Review Action : Get/Add/Delete/Like/UnLike/GetAll |
| POST API/Common/FAQ?action={action} |
Manage FAQ Action : Get/Add/Delete/Update/GetById/GetAll/Like/Unlike |
| POST API/Common/Testimonials?action={action} |
Manage Testimonials |