Quick Start

1. Add following line in your Podfile

pod 'zomato-ios-order-sdk'

2. Now run following command in your terminal

pod install

Initializing SDK

• In Application's AppDelegate

    #import <ZO2Kit/ZOnlineOrderManager.h>    
  

• In didFinishLaunchingWithOptions initialize SDK

     [ZOnlineOrderManager setAPIKey:@"orderingsdkapikey" andAPISecret:@"secretkey"];
  

• To set background color of Navigation bar, pass color value in this function

    [ZOnlineOrderManager setThemeColor:0xcb202d];
  

  Note: The text color of Navigation bar items is white.

• To set background color of Bottom Buttons, pass color value in this function

     [ZOnlineOrderManager setBottomBarColor:0x099e44];
  

• To set image for the right navigation bar button on Ordering Home use this function

    [ZOnlineOrderManager setRightActionButtonImage:[UIImage imageNamed:@"<imageName>"]]
  

  Note: For action on this button tap, set your view controller as delegate with [[ZOnlineOrderManager sharedInitializer] setDelegate:self] and use the delegate method didTapHomeRightActionBarButtonOnNavigationContoller:.

• To set the name of the User use this method

    [[ZOnlineOrderManager sharedInitializer] setUserFullName:@"<Name>"]
  

• To set the phone number of the user after starting order flow

            [[ZOnlineOrderManager sharedInitializer] setUserPhoneNumber:@"<user's phone number>"];
  

• Now when you want to place order pass your phone number in this function

  • For Modal Present

     [[ZOnlineOrderManager sharedInitializer] startOnlineOrderWithPhoneNumber:@"phone-number-10-digit" viewController:self];
    

  • For Navigation Push

    [[ZOnlineOrderManager sharedInitializer] startOnlineOrderWithPhoneNumber:@"phone-number-10-digit" pushOnNavViewController:self.navigationController];
    

• When order will be placed you will receive a notification with PlaceOrderTab Object inside it.

    extern NSString *const zOrderPlaced;
  

• When order status will change you will receive a notification with PlaceOrderTab Object inside it.

    extern NSString *const zOrderStatusChanged;
  

• Set the restaurant id before starting the order flow to open a particular restaurant.

    [[ZOnlineOrderManager sharedInitializer] setRestaurantId:<res_id>];
  

• To open order detail pass order id in the following function

    [[ZOnlineOrderManager sharedInitializer] showOrderDetailViewControllerForOrderID:@"<order-id-string>" viewController:self];
  

• To set zomato user token you need to call this function before starting online ordering flow

    [[ZOnlineOrderManager sharedInitializer] setZomatoUserToken:@"zomatoUserToken"];
  

• To get zomato user token you need to call this function and block in the function's params is invoked after token is generated

    [[ZOnlineOrderManager sharedInitializer] getZomatoUserTokenWithCompletionHandler:^(NSError *error, NSString *zomatoUserToken){ // code  }];
  

  Note: Whenever the ordering flow is started from the main application, an access token is generated, which is saved locally in the device storage and is used analogous to a session id. So, all user activity (orders, saved addressed) is mapped to this access token. The user's Zomato account is totally independent of this. Reinstall the application, logging out and clearing data removes the access token from the local storage and a new token is generated for the next time. This might lead to the loss of the details mapped to that particular user. Hence, the access token must be saved if the application wants to maintain the user data mapping.

• To remove all user logs

    [ZOnlineOrderManager invalidate];
  

• PlaceOrderTab Object reference:

    PlaceOrderTabObject.tabId : To get orderId
  
    PlaceOrderTabObject.statusText : To get Order Status
  
    PlaceOrderTabObject.createdTimeString : To get order Timing
  
    PlaceOrderTabObject.restaurant.name : To get Restaurant Name
  
    PlaceOrderTabObject.restaurant.location.locality : To get Restaurant Subzone
  
    PlaceOrderTabObject.restaurant.restThumbURL : To get Restaurant image
    
    PlaceOrderTabObject.order.itemsArray : An array of PlaceOrderItem objects
  

• PlaceOrderItem Object :

    PlaceOrderItem object has 'type' property which can take one of following values:
    	"dish" : food item 
  
    	"subtotal2" : subtotal (sum of the price of all dishes, without taxes or charges)
  
    	"tax" : tax (eg. VAT, Service Tax)
  
    	"charge" : extra charge (eg. Packaging Charge)
  
    	"extra" : extra charge (eg. Delivery Charge)
  
    	"voucher_discount" : discount given after applying any promo code
  
    	"dominos_coupon" :  discount given on orders placed at Domino’s after applying any promo code
  
    	"salt_discount", "salt_discounts" : discount automatically given by the merchant
  
    	"total_merchant" : amount charged by the merchant ( (subtotal2 + taxes + charges)- promo discount given by merchant [salt_discount])
  
    	"total", "total_user" : amount charged to the user (total_merchant - promo discount after applying code [voucher_discount])
  
  
    Other properties of PlaceOrderItem object are: 
    	quantity
    	totalCost
    	itemName
    	unitCost