List orders

curl --request GET \
  --url https://portal.urbnbox.io/api/vendor/v1/orders \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://portal.urbnbox.io/api/vendor/v1/orders', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://portal.urbnbox.io/api/vendor/v1/orders",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://portal.urbnbox.io/api/vendor/v1/orders"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://portal.urbnbox.io/api/vendor/v1/orders")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "ID": "<string>",
      "Status": "draft",
      "FulfillmentType": "<string>",
      "ClientName": "<string>",
      "ClientPhone": "<string>",
      "Address": "<string>",
      "ClientLat": 123,
      "ClientLng": 123,
      "ScheduledAt": "2023-11-07T05:31:56Z",
      "TotalKES": 123,
      "DeliveryFeeKES": 123,
      "PublicToken": "<string>",
      "IsCOD": true,
      "CODAmountKES": 123,
      "CreatedAt": "2023-11-07T05:31:56Z",
      "UpdatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "page_size": 123,
  "next_cursor": "<string>"
}

<string>

GET

api

vendor

orders

List orders

curl --request GET \
  --url https://portal.urbnbox.io/api/vendor/v1/orders \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://portal.urbnbox.io/api/vendor/v1/orders', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://portal.urbnbox.io/api/vendor/v1/orders",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://portal.urbnbox.io/api/vendor/v1/orders"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://portal.urbnbox.io/api/vendor/v1/orders")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "ID": "<string>",
      "Status": "draft",
      "FulfillmentType": "<string>",
      "ClientName": "<string>",
      "ClientPhone": "<string>",
      "Address": "<string>",
      "ClientLat": 123,
      "ClientLng": 123,
      "ScheduledAt": "2023-11-07T05:31:56Z",
      "TotalKES": 123,
      "DeliveryFeeKES": 123,
      "PublicToken": "<string>",
      "IsCOD": true,
      "CODAmountKES": 123,
      "CreatedAt": "2023-11-07T05:31:56Z",
      "UpdatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "page_size": 123,
  "next_cursor": "<string>"
}

<string>

Authorizations

X-API-Key

string

header

required

Vendor API key. Keys begin with the ubx_ prefix and identify vendor accounts.

Query Parameters

page_size

enum<integer>

default:25

Orders per page

Available options:

10,

25,

50,

100

cursor

string

The next_cursor value from the previous response

Response

Paginated order list

data

object[]

Show child attributes

page_size

integer

next_cursor

string

Pass as cursor for the next page. Empty on the last page

Delivery orders

Pickup-point shipments (Vendor API)

Pickup-point shipments (Partner API)

Pickup-point bookings (browser)

Shopify callbacks

List orders

Authorizations

Query Parameters

Response