### GoGet Production Environment Setup Source: https://api-docs.goget.my/index Steps for setting up and using the GoGet production environment for live API integrations. ```APIDOC ## Production Environment Setup ### Description This section details the process for setting up the GoGet production environment for live API integrations. ### Steps 1. Sign up for a GoGet account: `https://web.goget.my/`. 2. Click the 'Sign up' button. 3. Fill in your details. 4. Enter the OTP received on your mobile. 5. Navigate to the 'Credit' icon (top right) and select 'Business Plan'. 6. Choose a plan that suits your requirements. 7. Select your preferred payment method and proceed to pay. 8. Click 'OK' on the receipt. 9. Manually enter the production API URL: `https://web.goget.my/api` and log in with your credentials. 10. Generate your API Token. 11. Input your Callback URL in the designated field and update. ``` -------------------------------- ### GoGet Staging Environment Setup Source: https://api-docs.goget.my/index Steps for setting up and using the GoGet staging environment for testing API integrations. ```APIDOC ## Poster Staging Environment Setup ### Description This section outlines the steps to set up and utilize the GoGet staging environment for API integration testing. ### Steps 1. Navigate to the staging signup page: `https://staging-app.goget.my/sign_up`. 2. Log in using the provided credentials: Username: `gogetstaging`, Password: `getmyapis`. 3. Complete the signup form and submit. 4. Enter the OTP received on your mobile. 5. Navigate to the 'Credit' icon (top right) and select 'Business Plan'. 6. Choose a plan that suits your needs. 7. Select 'Billplz' as the payment method and proceed to pay. 8. Confirm successful payment. 9. Click 'OK' on the receipt. 10. Manually enter the staging API URL: `http://staging-api.goget.my/api` and log in with your credentials. 11. Generate an API token on the API page. 12. Input your Callback URL in the designated field and update. ## GoGetter Staging Environment Setup ### Description Instructions for merchants to test and familiarize themselves with the job lifecycle in the GoGetter app. ### Steps 1. Install the GoGetter app from the provided link. 2. Sign up as a GoGetter within the app. 3. Provide your name, email, and company name to your GoGet representative or email `business@goget.my` with the subject 'GoGetter Staging'. 4. Within 6 hours, you will gain access as a 'GoGetter' in the app. 5. Using your poster account, create a job. This job will be linked to your GoGetter account. 6. In the GoGetter app, navigate to 'My Jobs' to view the assigned job. 7. To trigger callback status updates, perform the following actions on the job: - Claim the job - Start the job - Start the tasks - Complete the tasks 8. Each action will trigger a callback to your specified URL, providing the latest job status and details. ``` -------------------------------- ### Example API Request Headers (JSON) Source: https://api-docs.goget.my/index This snippet shows the required headers for making authenticated requests to the GoGet API. It includes Authorization, Accept, and Content-Type. ```json { "Authorization": "Token token=9x54Y7aHnCMTPyzWWqBW", "Accept": "application/json", "Content-Type": "application/json" } ``` -------------------------------- ### Creating Premium Delivery Without Specific Start Time Source: https://api-docs.goget.my/index If you wish to create a Premium Delivery job without specifying an exact start time, set the 'FALLBACK' parameter to 'true'. This will auto-schedule the pickup for 10 AM on the next non-public holiday. ```json { "premium": true, "FALLBACK": true } ``` -------------------------------- ### Check GoGet Premium Delivery availability Source: https://api-docs.goget.my/index This section details how to check the availability of GoGet Premium Delivery service. It outlines the POST request to the /api/public/v1/jobs/time_check endpoint, including parameters for request time or start time, and describes the possible response fields. ```http POST /api/public/v1/jobs/time_check ``` ```json { "request_at": "2017-05-02 12:00", "success": false, "fallback": true, "pickup_start_at": "2017-05-02 12:30", "pickup_end_at": "2017-05-02 13:30", "dropoff_start_at": "2017-05-02 13:00", "dropoff_end_at": "2017-05-02 14:30", "failure_reasons": ["2017-05-02 is a public holiday"] } ``` -------------------------------- ### Example successful response for listing jobs Source: https://api-docs.goget.my/index This JSON object represents a successful response from the GoGet API when listing jobs. It includes a success message, and a 'data' array containing detailed job objects, each with associated tasks. The response adheres to the specified JSON format. ```json { "success": true, "info": "Successfully fetch all jobs", "data": [ { "id": 23049, "notes": "General Notes Testing", "ride_id": 1, "status": "open", "posted_at": "2022-10-21T16:04:59.787+08:00", "started_at": null, "distance_covered": 1, "cancelled_at": null, "expire_at": "2022-12-25T03:53:00.520+08:00", "start_at": "2022-12-25T03:03:00.520+08:00", "completed_at": null, "platform": "api", "reference": "GN-001", "non_halal": false, "simple_status": "searching", "credits_used": "30.0", "tracking_url": "https://develop-api.goget.my/tk/iam4ach1ko", "tracking_id": "iam4ach1ko", "guarantee": true, "tasks": [ { "id": 54475, "name": "Pick up", "location": "Pavilion", "location_lat": 3.1489, "location_long": 101.7133, "status": "open", "start_at": "2022-12-25T03:03:00.520+08:00", "end_at": "2022-12-25T03:48:00.520+08:00", "ended_at": null, "order": 0, "parking": true, "recipient_name": null, "recipient_phone_num": null, "reference": "A001", "sender_name": null, "sender_email": null, "location_notes": "Please contact PIC before you heading to the location", "location_url": "https://goo.gl/maps/bSedZcoX9aq9faUa9", "tracking_url": null, "tracking_id": null, "person_in_charge_name": null, "person_in_charge_phone_num": null, "has_edo": false, "proof_of_item_required": true, "attachments": [] }, { "id": 54476, "name": "Deliver", "location": "Sunway Velocity Malaysia", "location_lat": 3.1488612, "location_long": 101.711066, "status": "open", "start_at": "2022-12-25T03:12:00.520+08:00", "end_at": "2022-12-25T03:53:00.520+08:00", "ended_at": null, "order": 1, "parking": false, "recipient_name": "Michelle", "recipient_phone_num": "0162567271", "reference": "A002", "sender_name": "Mr.Lew", "sender_email": "Lew@gmail.com", "location_notes": "Please on time", "location_url": "https://g.page/SunwayVelocityMall?share", "tracking_url": "https://develop-app.goget.my/track/iam4ach1ko", "tracking_id": "iam4ach1ko", "person_in_charge_name": null, "person_in_charge_phone_num": null, "has_edo": false, "proof_of_item_required": true, "edo": { "receiver_name": null, "receiver_id": null, "receiver_relation": null }, "attachments": [] } ], "gogetters": [] } ] } ``` -------------------------------- ### Retrieve Remaining Credits (Bash) Source: https://api-docs.goget.my/index Retrieves the remaining credits for the current user using a GET request to the /api/public/v1/users/credits endpoint. Requires Authorization header. ```Bash -H "Authorization: Token" curl "https://staging-api.goget.my/api/public/v1/users/credits" \ -H "Accept: application/json" -H "Content-Type: application/json" ``` -------------------------------- ### List All Teams (Bash) Source: https://api-docs.goget.my/index Fetches a list of all teams associated with the current user, including details of gogetters within each team. This uses a GET request to the /api/public/v1/teams endpoint and requires an Authorization header. ```Bash curl "https://staging-api.goget.my/api/public/v1/teams" \ -H "Authorization: Token" -H "Accept: application/json" -H "Content-Type: application/json" ``` -------------------------------- ### GET /api/public/v1/jobs/{reference_id}/reference Source: https://api-docs.goget.my/index Retrieves jobs associated with the current user that match a specific reference ID. The results are sorted by creation date in descending order. ```APIDOC ## GET /api/public/v1/jobs/{reference_id}/reference ### Description Retrieves jobs which belong to the current user and have the given reference ID. The jobs returned are sorted by creation date, with the most recent appearing first. ### Method GET ### Endpoint `/api/public/v1/jobs/{reference_id}/reference` ### Parameters #### Path Parameters - **reference_id** (string) - Required - The reference ID of the job to retrieve. ### Request Example ```bash curl "https://staging-api.goget.my/api/public/v1/jobs/AB12311136/reference" \ -H "Authorization: Token" \ -H "Accept: application/json" \ -H "Content-Type: application/json" ``` ### Response #### Success Response (200) - **data** (array) - An array of objects containing job details, associated tasks, and GoGetters who claimed the job. #### Response Example ```json { "id": 4552, "notes": "", "ride_id": 1, "status": "in_progress", "posted_at": "2021-08-18T15:45:29.218+08:00", "started_at": "2021-08-18T15:46:54.079+08:00", "distance_covered": 0, "cancelled_at": null, "expire_at": "2021-08-18T17:20:15.582+08:00", "start_at": "2021-08-18T15:50:15.582+08:00", "completed_at": null, "platform": "pwa", "reference": "AB12311136", "non_halal": false, "premium": false, "simple_status": "started", "credits_used": "20.0", "tracking_url": "http://social-tools-teach-202-185-200-41.loca.lt/tk/001qlzgqun", "tracking_id": "001qlzgqun", "guarantee": false, "tasks": [ { "id": 8871, "name": "test", "location": "Let GoGetter Decide", "location_lat": null, "location_long": null, "status": "open", "start_at": "2021-08-18T15:50:15.582+08:00", "end_at": "2021-08-18T16:50:18.036+08:00", "ended_at": null, "order": 0, "parking": true, "recipient_name": null, "recipient_phone_num": null, "reference": null, "sender_name": null, "sender_email": null, "location_notes": null, "location_url": null, "tracking_url": null, "tracking_id": null, "person_in_charge_name": null, "person_in_charge_phone_num": null, "has_edo": false, "proof_of_item_required": false, "attachments": [ { "id": 395, "attachment": { "url": "https://goget-develop-attachments.s3-ap-southeast-1.amazonaws.com/uploads/attachment/attachment/395/file.jpeg", "big_thumb": { "url": "https://goget-develop-attachments.s3-ap-southeast-1.amazonaws.com/uploads/attachment/attachment/395/big_thumb_file.jpeg" }, "medium_thumb": { "url": "https://goget-develop-attachments.s3-ap-southeast-1.amazonaws.com/uploads/attachment/attachment/395/medium_thumb_file.jpeg" }, "thumb": { "url": "https://goget-develop-attachments.s3-ap-southeast-1.amazonaws.com/uploads/attachment/attachment/395/thumb_file.jpeg" } } } ] }, { "id": 8872, "name": "Deliver", "location": "GoGet Malaysia, Jalan Burhanuddin Helmi, Taman Tun Dr Ismail, Kuala Lumpur, Federal Territory of Kuala Lumpur, Malaysia", "location_lat": 3.1523195, "location_long": 101.6227335, "status": "open", "start_at": "2021-08-18T16:20:15.582+08:00", "end_at": "2021-08-18T17:20:15.582+08:00", "ended_at": null, "order": 1, "parking": false, "recipient_name": null, "recipient_phone_num": null, "reference": null, "sender_name": null, "sender_email": null, "location_notes": null, "location_url": null, "tracking_url": "https://localhost:8080/track/001qlzgqun", "tracking_id": "001qlzgqun", "person_in_charge_name": null, "person_in_charge_phone_num": null, "has_edo": false, "proof_of_item_required": false, "attachments": [] } ], "gogetters": [ { "email": "60@mail.com", "avatar": null, "name": "Reshvin Singh Sandhu", "phone_num": "60146413278", "last_location_lat": 3.149344361452593, "last_location_long": 101.6245161640974 } ] } ``` ``` -------------------------------- ### GET /api/public/v1/teams Source: https://api-docs.goget.my/index Lists all teams associated with the current user. Each team object includes a list of its gogetters. ```APIDOC ## List all teams ### Description Returns a list of all teams of the user. Each team object in the list also contains the list of all goggetters of the team. ### Method GET ### Endpoint /api/public/v1/teams ### Parameters No Parameters ### Request Example ```bash curl "https://staging-api.goget.my/api/public/v1/teams" \ -H "Authorization: Token" \ -H "Accept: application/json" \ -H "Content-Type: application/json" ``` ### Response #### Success Response (200) - **success** (boolean) - True if the request has been a success. - **info** (string) - A message which provides information related to the request. - **data** (array) - An array of all teams of the user. Each element is a team object. - **id** (string) - The unique identifier for the team. - **title** (string) - The name of the team. - **gogetters** (array) - A list of gogetters belonging to the team. - **poster_referral_code** (string) - Referral code of the gogetter. - **name** (string) - Name of the gogetter. - **avatar** (string) - URL to the gogetter's avatar. - **jobs_completed** (integer) - Number of jobs completed by the gogetter. - **blocked** (boolean) - Indicates if the gogetter is blocked. #### Response Example ```json { "success": true, "info": "Teams Loaded", "data": [ { "id": "1", "title": "MY TEAM", "gogetters": [ { "poster_referral_code": "abcd1234", "name": "Gordon Getter", "avatar": "http://my.picture.com/mypic", "jobs_completed": 0, "blocked": false } ] } ] } ``` ``` -------------------------------- ### GET /api/public/v1/favourite_gogetter Source: https://api-docs.goget.my/index Retrieves a list of favorite GoGetters, including their name, avatar, and number of completed jobs. ```APIDOC ## GET /api/public/v1/favourite_gogetter ### Description Retrieves a list of favorite GoGetters along with their details. ### Method GET ### Endpoint /api/public/v1/favourite_gogetter ### Parameters #### Path Parameters None #### Query Parameters None ### Response #### Success Response (200) - **success** (boolean) - True if the request has been a success. - **info** (string) - A message which provides information related to the request. - **data** (array) - An array of all favourite gogetter objects of the user with key value pairs containing name, avatar, number of jobs completed. #### Response Example { "success": true, "info": "Successfully retrieved favourite gogetters.", "data": [ { "name": "John Doe", "avatar": "http://example.com/avatar.jpg", "jobs_completed": 150 }, { "name": "Jane Smith", "avatar": "http://example.com/avatar2.jpg", "jobs_completed": 200 } ] } ``` -------------------------------- ### Authentication API Source: https://api-docs.goget.my/index Provides endpoints for authentication, including signing up for developer keys. ```APIDOC ## POST /auth/developer-signup ### Description Initiates the process to sign up for a developer key. ### Method POST ### Endpoint /auth/developer-signup ### Parameters #### Request Body - **company_name** (string) - Required - The name of your company. - **contact_email** (string) - Required - Your contact email address. - **api_usage_description** (string) - Required - A brief description of how you plan to use the API. ### Request Example ```json { "company_name": "My Tech Solutions", "contact_email": "dev@mytech.com", "api_usage_description": "Integrating GoGet delivery services into our e-commerce platform." } ``` ### Response #### Success Response (200) - **status** (string) - Confirmation of the signup request. - **message** (string) - Information about the next steps. #### Response Example ```json { "status": "signup_initiated", "message": "Your request for a developer key has been received. You will be contacted via email within 48 hours." } ``` ``` -------------------------------- ### POST /api/public/v2/jobs Source: https://api-docs.goget.my/index This endpoint allows you to create a new job. You need to provide pickup and dropoff details, along with other job-specific parameters. ```APIDOC ## POST /api/public/v2/jobs ### Description Creates a new job object with valid attributes. ### Method POST ### Endpoint /api/public/v2/jobs ### Parameters #### Header Parameters - **Authorization** (string) - Required - Bearer token for authentication - **Accept** (string) - Required - `application/json` - **Content-Type** (string) - Required - `application/json` #### Request Body - **pickup** (object) - Required - Details for the pickup location - **name** (string) - Required - Name of the pickup location - **location** (string) - Required - Address of the pickup location - **location_lat** (number) - Required - Latitude of the pickup location - **location_long** (number) - Required - Longitude of the pickup location - **parking** (boolean) - Optional - Whether parking is available - **start_at** (string) - Required - Start time for the pickup (ISO 8601 format) - **reference** (string) - Optional - Reference for the pickup - **location_notes** (string) - Optional - Additional notes for the pickup location - **person_in_charge_name** (string) - Optional - Name of the person in charge at pickup - **person_in_charge_phone_num** (string) - Optional - Phone number of the person in charge at pickup - **dropoff** (array) - Required - Array of dropoff locations - **location** (string) - Required - Address of the dropoff location - **location_lat** (number) - Required - Latitude of the dropoff location - **location_long** (number) - Required - Longitude of the dropoff location - **parking** (boolean) - Optional - Whether parking is available - **recipient_name** (string) - Optional - Name of the recipient at dropoff - **recipient_phone_num** (string) - Optional - Phone number of the recipient at dropoff - **reference** (string) - Optional - Reference for the dropoff - **sender_name** (string) - Optional - Name of the sender - **sender_email** (string) - Optional - Email of the sender - **location_notes** (string) - Optional - Additional notes for the dropoff location - **ride_id** (integer) - Required - Identifier for the ride - **notes** (string) - Optional - General notes for the job - **bulky** (boolean) - Optional - Whether the job involves bulky items - **premium** (boolean) - Optional - Whether the job is premium - **reference** (string) - Optional - General reference for the job - **edo** (boolean) - Optional - Whether electronic proof of delivery is required - **merchant_token** (string) - Optional - Merchant token for the job - **on_demand_fallback** (boolean) - Optional - Whether to use on-demand fallback - **weekday_fallback** (boolean) - Optional - Whether to use weekday fallback - **flexi** (boolean) - Optional - Whether the job is flexible - **route** (boolean) - Optional - Whether the job has a predefined route - **exclusive** (boolean) - Optional - Whether the job is exclusive - **non_halal** (boolean) - Optional - Whether the job is non-halal - **sms** (boolean) - Optional - Whether to send SMS notifications - **blast_pool** (string) - Optional - Specifies the pool for blasting the job ### Request Example ```json { "pickup": { "name": "A API Dispatch job with label flowers Job test - API GUARANTEE EGG FLOWER ", "location": "Kuala Lumpur City Centre, Kuala Lumpur, Federal Territory of Kuala Lumpur, Malaysia", "location_lat": 3.1225385, "location_long": 101.5885444, "parking": false, "start_at": "2023-10-02T10:00:00-05:00", "reference": "XYQ", "location_notes": "unit A3-B, ABC Sdn Bhd, Marketing Department", "person_in_charge_name": "Joe", "person_in_charge_phone_num": "012345678" }, "dropoff": [ { "location": "Berjaya Times Square, Jalan Imbi, Imbi, Kuala Lumpur, Federal Territory of Kuala Lumpur, Malaysia", "location_lat": 3.165701700000001, "location_long": 101.6531554, "parking": false, "recipient_name": "Bobb", "recipient_phone_num": "0121231234", "reference": "XYQ", "sender_name": "John", "sender_email": "john@mail.com", "location_notes": "unit A3-B, ABC Sdn Bhd, Marketing Department" } ], "ride_id": 2, "notes": "Job test - 2", "bulky": false, "premium": true, "reference": "AB12311136", "edo": false, "merchant_token": "A12b1232f123ABV12Hasc", "on_demand_fallback": false, "weekday_fallback": false, "flexi": false, "route": false, "exclusive": false, "non_halal": false, "sms": false, "blast_pool": "anyone" } ``` ### Response #### Success Response (200) - **success** (boolean) - Indicates if the operation was successful - **info** (string) - Provides information about the operation - **data** (object) - Contains the details of the created job - **success** (boolean) - Indicates if the job creation within data was successful - **credits_remaining** (integer) - Remaining credits after the job creation - **job** (object) - Details of the created job - **id** (integer) - Unique identifier for the job - **notes** (string) - Notes associated with the job - **ride_id** (integer) - Identifier for the ride - **status** (string) - Current status of the job - **posted_at** (string) - Timestamp when the job was posted - **started_at** (string) - Timestamp when the job started - **distance_covered** (number) - Distance covered by the job - **cancelled_at** (string) - Timestamp when the job was cancelled - **expire_at** (string) - Timestamp when the job expires - **start_at** (string) - Timestamp for the job start - **completed_at** (string) - Timestamp when the job was completed - **platform** (string) - Platform used for the job - **reference** (string) - Reference for the job - **non_halal** (boolean) - Indicates if the job is non-halal - **premium** (boolean) - Indicates if the job is premium - **simple_status** (string) - Simplified status of the job - **credits_used** (string) - Credits used for the job - **tracking_url** (string) - URL for tracking the job - **tracking_id** (string) - Identifier for tracking the job - **guarantee** (boolean) - Indicates if the job has a guarantee - **tasks** (array) - Array of tasks associated with the job - **id** (integer) - Unique identifier for the task - **name** (string) - Name of the task - **location** (string) - Location of the task - **location_lat** (number) - Latitude of the task location - **location_long** (number) - Longitude of the task location - **status** (string) - Status of the task - **start_at** (string) - Start time of the task - **end_at** (string) - End time of the task - **ended_at** (string) - Timestamp when the task ended - **order** (integer) - Order of the task - **parking** (boolean) - Whether parking is available - **recipient_name** (string) - Name of the recipient - **recipient_phone_num** (string) - Phone number of the recipient - **reference** (string) - Reference for the task - **sender_name** (string) - Name of the sender - **sender_email** (string) - Email of the sender - **location_notes** (string) - Notes for the task location - **location_url** (string) - URL for the task location - **tracking_url** (string) - Tracking URL for the task - **tracking_id** (string) - Tracking ID for the task - **person_in_charge_name** (string) - Name of the person in charge - **person_in_charge_phone_num** (string) - Phone number of the person in charge - **has_edo** (boolean) - Indicates if electronic proof of delivery is required - **proof_of_item_required** (boolean) - Indicates if proof of item is required - **attachments** (array) - Array of attachments for the task - **edo** (object) - Electronic proof of delivery details - **receiver_name** (string) - Name of the receiver - **receiver_id** (string) - ID of the receiver - **receiver_relation** (string) - Relation of the receiver - **gogetters** (array) - Array of GoGetters assigned to the job - **messages** (array) - Array of messages related to the job ### Response Example ```json { "success": true, "info": "Job Created Successfully", "data": { "success": true, "credits_remaining": 19984, "job": { "id": 24397, "notes": "Job test - 2", "ride_id": 2, "status": "open", "posted_at": "2022-12-29T22:23:18.872+08:00", "started_at": null, "distance_covered": 15, "cancelled_at": null, "expire_at": "2023-10-02T23:42:00.000+08:00", "start_at": "2023-10-02T23:00:00.000+08:00", "completed_at": null, "platform": "api", "reference": "AB12311136", "non_halal": false, "premium": true, "simple_status": "searching", "credits_used": "18.0", "tracking_url": "https://develop-api.goget.my/tk/k9x4uh4csh", "tracking_id": "k9x4uh4csh", "guarantee": true, "tasks": [ { "id": 56872, "name": "Pick up", "location": "Kuala Lumpur City Centre, Kuala Lumpur, Federal Territory of Kuala Lumpur, Malaysia", "location_lat": 3.1225385, "location_long": 101.5885444, "status": "open", "start_at": "2023-10-02T23:00:00.000+08:00", "end_at": null, "ended_at": null, "order": 0, "parking": false, "recipient_name": null, "recipient_phone_num": null, "reference": "XYQ", "sender_name": null, "sender_email": null, "location_notes": "unit A3-B, ABC Sdn Bhd, Marketing Department", "location_url": null, "tracking_url": null, "tracking_id": null, "person_in_charge_name": null, "person_in_charge_phone_num": null, "has_edo": false, "proof_of_item_required": true, "attachments": [] }, { "id": 56873, "name": "Deliver", "location": "Berjaya Times Square, Jalan Imbi, Imbi, Kuala Lumpur, Federal Territory of Kuala Lumpur, Malaysia", "location_lat": 3.1657017, "location_long": 101.6531554, "status": "open", "start_at": "2023-10-02T23:27:00.000+08:00", "end_at": "2023-10-02T23:42:00.000+08:00", "ended_at": null, "order": 1, "parking": false, "recipient_name": "Bobb", "recipient_phone_num": "0121231234", "reference": "XYQ", "sender_name": "John", "sender_email": "john@mail.com", "location_notes": "unit A3-B, ABC Sdn Bhd, Marketing Department", "location_url": null, "tracking_url": "https://develop-app.goget.my/track/k9x4uh4csh", "tracking_id": "k9x4uh4csh", "person_in_charge_name": null, "person_in_charge_phone_num": null, "has_edo": false, "proof_of_item_required": true, "edo": { "receiver_name": null, "receiver_id": null, "receiver_relation": null }, "attachments": [] } ], "gogetters": [] }, "messages": ["Your credit has been deducted by RM18.0"] } } ``` ``` -------------------------------- ### GET /api/public/v1/favourite_gogetters Source: https://api-docs.goget.my/index Retrieves a list of the user's favorite gogetters. This is useful for quickly accessing preferred delivery personnel. ```APIDOC ## List all favourite gogetters ### Description Returns a list of all favourite gogetters current user have. ### Method GET ### Endpoint /api/public/v1/favourite_gogetters ### Parameters No Parameters ### Request Example ```bash curl "https://staging-api.goget.my/api/public/v1/favourite_gogetters" \ -H "Authorization: Token" \ -H "Accept: application/json" \ -H "Content-Type: application/json" ``` ### Response #### Success Response (200) - **success** (boolean) - True if the request has been a success. - **info** (string) - A message which provides information related to the request. - **data** (array) - An array of favourite gogetters. - **poster_referral_code** (string) - Referral code of the gogetter. - **name** (string) - Name of the gogetter. - **avatar** (string) - URL to the gogetter's avatar. - **jobs_completed** (integer) - Number of jobs completed by the gogetter. - **blocked** (boolean) - Indicates if the gogetter is blocked. #### Response Example ```json { "success": true, "info": "Favourite gogetters loaded", "data": [ { "poster_referral_code": "abcd1234", "name": "Gordon Getter", "avatar": "http://my.picture.com/mypic", "jobs_completed": 0, "blocked": false } ] } ``` ``` -------------------------------- ### Create GoGet Job using cURL Source: https://api-docs.goget.my/index This snippet demonstrates how to create a new job using the GoGet API via cURL. It includes setting authorization headers, content type, and the request body with pickup and dropoff details. The response shows the success status and job details. ```bash curl "https://staging-api.goget.my/api/public/v2/jobs" \ -H "Authorization: Token" \ -H "Accept: application/json" \ -H "Content-Type: application/json" ``` ```json { "pickup": { "name": "A API Dispatch job with label flowers Job test - API GUARANTEE EGG FLOWER ", "location": "Kuala Lumpur City Centre, Kuala Lumpur, Federal Territory of Kuala Lumpur, Malaysia", "location_lat": 3.1225385, "location_long": 101.5885444, "parking": false, "start_at": "2023-10-02T10:00:00-05:00", "reference": "XYQ", "location_notes": "unit A3-B, ABC Sdn Bhd, Marketing Department", "person_in_charge_name": "Joe", "person_in_charge_phone_num": "012345678" }, "dropoff": [ { "location": "Berjaya Times Square, Jalan Imbi, Imbi, Kuala Lumpur, Federal Territory of Kuala Lumpur, Malaysia", "location_lat": 3.165701700000001, "location_long": 101.6531554, "parking": false, "recipient_name": "Bobb", "recipient_phone_num": "0121231234", "reference": "XYQ", "sender_name": "John", "sender_email": "john@mail.com", "location_notes": "unit A3-B, ABC Sdn Bhd, Marketing Department" } ], "ride_id": 2, "notes": "Job test - 2", "bulky": false, "premium": true, "reference": "AB12311136", "edo": false, "merchant_token": "A12b1232f123ABV12Hasc", "on_demand_fallback": false, "weekday_fallback": false, "flexi": false, "route": false, "exclusive": false, "non_halal": false, "sms": false, "blast_pool": "anyone" } ``` ```json { "success": true, "info": "Job Created Successfully", "data": { "success": true, "credits_remaining": 19984, "job": { "id": 24397, "notes": "Job test - 2", "ride_id": 2, "status": "open", "posted_at": "2022-12-29T22:23:18.872+08:00", "started_at": null, "distance_covered": 15, "cancelled_at": null, "expire_at": "2023-10-02T23:42:00.000+08:00", "start_at": "2023-10-02T23:00:00.000+08:00", "completed_at": null, "platform": "api", "reference": "AB12311136", "non_halal": false, "premium": true, "simple_status": "searching", "credits_used": "18.0", "tracking_url": "https://develop-api.goget.my/tk/k9x4uh4csh", "tracking_id": "k9x4uh4csh", "guarantee": true, "tasks": [ { "id": 56872, "name": "Pick up", "location": "Kuala Lumpur City Centre, Kuala Lumpur, Federal Territory of Kuala Lumpur, Malaysia", "location_lat": 3.1225385, "location_long": 101.5885444, "status": "open", "start_at": "2023-10-02T23:00:00.000+08:00", "end_at": null, "ended_at": null, "order": 0, "parking": false, "recipient_name": null, "recipient_phone_num": null, "reference": "XYQ", "sender_name": null, "sender_email": null, "location_notes": "unit A3-B, ABC Sdn Bhd, Marketing Department", "location_url": null, "tracking_url": null, "tracking_id": null, "person_in_charge_name": null, "person_in_charge_phone_num": null, "has_edo": false, "proof_of_item_required": true, "attachments": [] }, { "id": 56873, "name": "Deliver", "location": "Berjaya Times Square, Jalan Imbi, Imbi, Kuala Lumpur, Federal Territory of Kuala Lumpur, Malaysia", "location_lat": 3.1657017, "location_long": 101.6531554, "status": "open", "start_at": "2023-10-02T23:27:00.000+08:00", "end_at": "2023-10-02T23:42:00.000+08:00", "ended_at": null, "order": 1, "parking": false, "recipient_name": "Bobb", "recipient_phone_num": "0121231234", "reference": "XYQ", "sender_name": "John", "sender_email": "john@mail.com", "location_notes": "unit A3-B, ABC Sdn Bhd, Marketing Department", "location_url": null, "tracking_url": "https://develop-app.goget.my/track/k9x4uh4csh", "tracking_id": "k9x4uh4csh", "person_in_charge_name": null, "person_in_charge_phone_num": null, "has_edo": false, "proof_of_item_required": true, "edo": { "receiver_name": null, "receiver_id": null, "receiver_relation": null }, "attachments": [] } ], "gogetters": [] }, "messages": ["Your credit has been deducted by RM18.0"] } } ```