NAV Navbar
Shell HTTP JavaScript Ruby Python PHP Java Go

Kreezalid API v1.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Kreezalid API is organized around REST. If you have a custom domain: https://your-domain.com/api/v1/

If you don't have a custom domain: https://your-subdomain.mykreezalid.com/api/v1/

Adding the version number in the URL ensures smooth transition to future version (i.e being able to offer multiple API endpoints simultaneously).

Kreezalid has a PHP SDK to help you to make API calls. How to use it ?

First, instantiation of our object:

$api = new KreezalidApi();

Then, we can set config, which will be the same for all our requests:

$api->Config->setApiSecret('YourSecretKey');

$api->Config->setApiKey('YourMail');

$api->Config->setApiUrl('YourSubDomain');

Now we can make our calls with $api.

Base URLs:

Terms of service Email: Support License: Apache 2.0

Authentication

listing

Listing description to set in Listings Controller

Retrieve a listing

Code samples

# You can also use wget
curl -X GET https://subdomain.mykreezalid.com/api/v1/listings/{id}.json \
  -H 'Accept: application/json'

GET https://subdomain.mykreezalid.com/api/v1/listings/{id}.json HTTP/1.1
Host: subdomain.mykreezalid.com
Accept: application/json


const headers = {
  'Accept':'application/json'
};

fetch('https://subdomain.mykreezalid.com/api/v1/listings/{id}.json',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://subdomain.mykreezalid.com/api/v1/listings/{id}.json',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://subdomain.mykreezalid.com/api/v1/listings/{id}.json', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://subdomain.mykreezalid.com/api/v1/listings/{id}.json', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://subdomain.mykreezalid.com/api/v1/listings/{id}.json");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://subdomain.mykreezalid.com/api/v1/listings/{id}.json", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /listings/{id}.json

Retrieve a listing

Parameters

Name In Type Required Description
id path integer true ID of your listing.

Example responses

200 Response

[
  {
    "id": 0,
    "object": "string",
    "attributes": [],
    "category": {
      "id": 0,
      "object": "string",
      "title": "string",
      "url": "string"
    },
    "city": "string",
    "country": "string",
    "cover": "string",
    "currency": "string",
    "date_online": "2020-11-23T14:57:42Z",
    "description": "string",
    "external_id": 0,
    "formatted_price": "string",
    "lat": 0,
    "lng": 0,
    "location": "string",
    "medias": "string",
    "price": 0,
    "price_unit": 0,
    "price_with_currency": "string",
    "quantity": 0,
    "quantity_selector": "string",
    "requires_shipping": 0,
    "state": "string",
    "status": "string",
    "user": {
      "id": 0,
      "object": "string",
      "address_city": "string",
      "address_country": "string",
      "address_line1": "string",
      "address_line2": "string",
      "address_state": "string",
      "address_zipcode": "string",
      "attributes": [],
      "avatar": "string",
      "business_name": "string",
      "can_post_listing": null,
      "created": "2020-11-23T14:57:42Z",
      "email": "string",
      "first_name": "string",
      "group": [
        {
          "object": "string",
          "id": 0,
          "name": "string",
          "alias": "string"
        }
      ],
      "group_alias": "string",
      "group_id": "string",
      "group_name": "string",
      "lang": "string",
      "last_name": "string",
      "locale": "string",
      "note": 0,
      "phone_number": "string",
      "profile_url": "string",
      "public_name": "string",
      "status": "enabled",
      "review_count": 0,
      "timezone": "string",
      "username": "string"
    },
    "supplier": {
      "id": 0,
      "object": "string",
      "address_city": "string",
      "address_country": "string",
      "address_line1": "string",
      "address_line2": "string",
      "address_state": "string",
      "address_zipcode": "string",
      "attributes": [],
      "avatar": "string",
      "business_name": "string",
      "can_post_listing": null,
      "created": "2020-11-23T14:57:42Z",
      "email": "string",
      "first_name": "string",
      "group": [
        {
          "object": "string",
          "id": 0,
          "name": "string",
          "alias": "string"
        }
      ],
      "group_alias": "string",
      "group_id": "string",
      "group_name": "string",
      "lang": "string",
      "last_name": "string",
      "locale": "string",
      "note": 0,
      "phone_number": "string",
      "profile_url": "string",
      "public_name": "string",
      "status": "enabled",
      "review_count": 0,
      "timezone": "string",
      "username": "string"
    },
    "title": "string",
    "url": "string",
    "valid_until": "2020-11-23T14:57:42Z",
    "weight": 0
  }
]

Responses

Status Meaning Description Schema
200 OK Listing with id = {id} Inline

Response Schema

Status Code 200

One listing

Name Type Required Restrictions Description
anonymous [Listing] false none One listing
» id integer false none none
» object string false none none
» attributes array false none none
» category Category false none none
»» id integer false none none
»» object string false none none
»» title string false none none
»» url string false none none
» city string false none none
» country string false none none
» cover string false none none
» currency string false none none
» date_online string(date-time) false none none
» description string false none none
» external_id integer false none none
» formatted_price string false none none
» lat number false none none
» lng number false none none
» location string false none none
» medias string false none none
» price number false none none
» price_unit integer false none none
» price_with_currency string false none none
» quantity integer false none none
» quantity_selector string false none none
» requires_shipping integer false none none
» state string false none none
» status string false none none
» user User false none none
»» id integer false none none
»» object string false none none
»» address_city string false none none
»» address_country string false none none
»» address_line1 string false none none
»» address_line2 string false none none
»» address_state string false none none
»» address_zipcode string false none none
»» attributes array false none none
»» avatar string false none none
»» business_name string false none none
»» can_post_listing bool false none none
»» created string(date-time) false none none
»» email string false none none
»» first_name string false none none
»» group [Group] false none none
»»» object string false none none
»»» id integer false none none
»»» name string false none none
»»» alias string false none none
»» group_alias string false none none
»» group_id string false none none
»» group_name string false none none
»» lang string false none none
»» last_name string false none none
»» locale string false none none
»» note integer false none none
»» phone_number string false none none
»» profile_url string false none none
»» public_name string false none none
»» status string false none enabled/disabled
»» review_count integer false none none
»» timezone string false none none
»» username string false none none
» supplier User false none none
» title string false none none
» url string false none none
» valid_until string(date-time) false none none
» weight number false none none

Enumerated Values

Property Value
status enabled
status disabled

Create a listing

Code samples

# You can also use wget
curl -X POST https://subdomain.mykreezalid.com/api/v1/listings \
  -H 'Accept: application/json'

POST https://subdomain.mykreezalid.com/api/v1/listings HTTP/1.1
Host: subdomain.mykreezalid.com
Accept: application/json


const headers = {
  'Accept':'application/json'
};

fetch('https://subdomain.mykreezalid.com/api/v1/listings',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'https://subdomain.mykreezalid.com/api/v1/listings',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('https://subdomain.mykreezalid.com/api/v1/listings', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://subdomain.mykreezalid.com/api/v1/listings', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://subdomain.mykreezalid.com/api/v1/listings");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://subdomain.mykreezalid.com/api/v1/listings", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /listings

Create a listing

Example responses

200 Response

[
  {
    "id": 0,
    "object": "string",
    "attributes": [],
    "category": {
      "id": 0,
      "object": "string",
      "title": "string",
      "url": "string"
    },
    "city": "string",
    "country": "string",
    "cover": "string",
    "currency": "string",
    "date_online": "2020-11-23T14:57:42Z",
    "description": "string",
    "external_id": 0,
    "formatted_price": "string",
    "lat": 0,
    "lng": 0,
    "location": "string",
    "medias": "string",
    "price": 0,
    "price_unit": 0,
    "price_with_currency": "string",
    "quantity": 0,
    "quantity_selector": "string",
    "requires_shipping": 0,
    "state": "string",
    "status": "string",
    "user": {
      "id": 0,
      "object": "string",
      "address_city": "string",
      "address_country": "string",
      "address_line1": "string",
      "address_line2": "string",
      "address_state": "string",
      "address_zipcode": "string",
      "attributes": [],
      "avatar": "string",
      "business_name": "string",
      "can_post_listing": null,
      "created": "2020-11-23T14:57:42Z",
      "email": "string",
      "first_name": "string",
      "group": [
        {
          "object": "string",
          "id": 0,
          "name": "string",
          "alias": "string"
        }
      ],
      "group_alias": "string",
      "group_id": "string",
      "group_name": "string",
      "lang": "string",
      "last_name": "string",
      "locale": "string",
      "note": 0,
      "phone_number": "string",
      "profile_url": "string",
      "public_name": "string",
      "status": "enabled",
      "review_count": 0,
      "timezone": "string",
      "username": "string"
    },
    "supplier": {
      "id": 0,
      "object": "string",
      "address_city": "string",
      "address_country": "string",
      "address_line1": "string",
      "address_line2": "string",
      "address_state": "string",
      "address_zipcode": "string",
      "attributes": [],
      "avatar": "string",
      "business_name": "string",
      "can_post_listing": null,
      "created": "2020-11-23T14:57:42Z",
      "email": "string",
      "first_name": "string",
      "group": [
        {
          "object": "string",
          "id": 0,
          "name": "string",
          "alias": "string"
        }
      ],
      "group_alias": "string",
      "group_id": "string",
      "group_name": "string",
      "lang": "string",
      "last_name": "string",
      "locale": "string",
      "note": 0,
      "phone_number": "string",
      "profile_url": "string",
      "public_name": "string",
      "status": "enabled",
      "review_count": 0,
      "timezone": "string",
      "username": "string"
    },
    "title": "string",
    "url": "string",
    "valid_until": "2020-11-23T14:57:42Z",
    "weight": 0
  }
]

Responses

Status Meaning Description Schema
200 OK List of all your listings Inline

Response Schema

Status Code 200

List of all listings

Name Type Required Restrictions Description
anonymous [Listing] false none List of all listings
» id integer false none none
» object string false none none
» attributes array false none none
» category Category false none none
»» id integer false none none
»» object string false none none
»» title string false none none
»» url string false none none
» city string false none none
» country string false none none
» cover string false none none
» currency string false none none
» date_online string(date-time) false none none
» description string false none none
» external_id integer false none none
» formatted_price string false none none
» lat number false none none
» lng number false none none
» location string false none none
» medias string false none none
» price number false none none
» price_unit integer false none none
» price_with_currency string false none none
» quantity integer false none none
» quantity_selector string false none none
» requires_shipping integer false none none
» state string false none none
» status string false none none
» user User false none none
»» id integer false none none
»» object string false none none
»» address_city string false none none
»» address_country string false none none
»» address_line1 string false none none
»» address_line2 string false none none
»» address_state string false none none
»» address_zipcode string false none none
»» attributes array false none none
»» avatar string false none none
»» business_name string false none none
»» can_post_listing bool false none none
»» created string(date-time) false none none
»» email string false none none
»» first_name string false none none
»» group [Group] false none none
»»» object string false none none
»»» id integer false none none
»»» name string false none none
»»» alias string false none none
»» group_alias string false none none
»» group_id string false none none
»» group_name string false none none
»» lang string false none none
»» last_name string false none none
»» locale string false none none
»» note integer false none none
»» phone_number string false none none
»» profile_url string false none none
»» public_name string false none none
»» status string false none enabled/disabled
»» review_count integer false none none
»» timezone string false none none
»» username string false none none
» supplier User false none none
» title string false none none
» url string false none none
» valid_until string(date-time) false none none
» weight number false none none

Enumerated Values

Property Value
status enabled
status disabled

user

Users

List all users

Code samples

# You can also use wget
curl -X GET https://subdomain.mykreezalid.com/api/v1/users.json \
  -H 'Accept: application/json'

GET https://subdomain.mykreezalid.com/api/v1/users.json HTTP/1.1
Host: subdomain.mykreezalid.com
Accept: application/json


const headers = {
  'Accept':'application/json'
};

fetch('https://subdomain.mykreezalid.com/api/v1/users.json',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://subdomain.mykreezalid.com/api/v1/users.json',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://subdomain.mykreezalid.com/api/v1/users.json', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://subdomain.mykreezalid.com/api/v1/users.json', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://subdomain.mykreezalid.com/api/v1/users.json");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://subdomain.mykreezalid.com/api/v1/users.json", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /users.json

Returns a list of your users. The users are returned sorted by creation date, with the most recent users appearing first.

Example responses

200 Response

[
  {
    "id": 0,
    "object": "string",
    "address_city": "string",
    "address_country": "string",
    "address_line1": "string",
    "address_line2": "string",
    "address_state": "string",
    "address_zipcode": "string",
    "attributes": [],
    "avatar": "string",
    "business_name": "string",
    "can_post_listing": null,
    "created": "2020-11-23T14:57:42Z",
    "email": "string",
    "first_name": "string",
    "group": [
      {
        "object": "string",
        "id": 0,
        "name": "string",
        "alias": "string"
      }
    ],
    "group_alias": "string",
    "group_id": "string",
    "group_name": "string",
    "lang": "string",
    "last_name": "string",
    "locale": "string",
    "note": 0,
    "phone_number": "string",
    "profile_url": "string",
    "public_name": "string",
    "status": "enabled",
    "review_count": 0,
    "timezone": "string",
    "username": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK List of all your users Inline

Response Schema

Status Code 200

List of all users

Name Type Required Restrictions Description
anonymous [User] false none List of all users
» id integer false none none
» object string false none none
» address_city string false none none
» address_country string false none none
» address_line1 string false none none
» address_line2 string false none none
» address_state string false none none
» address_zipcode string false none none
» attributes array false none none
» avatar string false none none
» business_name string false none none
» can_post_listing bool false none none
» created string(date-time) false none none
» email string false none none
» first_name string false none none
» group [Group] false none none
»» object string false none none
»» id integer false none none
»» name string false none none
»» alias string false none none
» group_alias string false none none
» group_id string false none none
» group_name string false none none
» lang string false none none
» last_name string false none none
» locale string false none none
» note integer false none none
» phone_number string false none none
» profile_url string false none none
» public_name string false none none
» status string false none enabled/disabled
» review_count integer false none none
» timezone string false none none
» username string false none none

Enumerated Values

Property Value
status enabled
status disabled

Retrieve a user

Code samples

# You can also use wget
curl -X GET https://subdomain.mykreezalid.com/api/v1/users/{id}.json \
  -H 'Accept: application/json'

GET https://subdomain.mykreezalid.com/api/v1/users/{id}.json HTTP/1.1
Host: subdomain.mykreezalid.com
Accept: application/json


const headers = {
  'Accept':'application/json'
};

fetch('https://subdomain.mykreezalid.com/api/v1/users/{id}.json',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://subdomain.mykreezalid.com/api/v1/users/{id}.json',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://subdomain.mykreezalid.com/api/v1/users/{id}.json', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://subdomain.mykreezalid.com/api/v1/users/{id}.json', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://subdomain.mykreezalid.com/api/v1/users/{id}.json");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://subdomain.mykreezalid.com/api/v1/users/{id}.json", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /users/{id}.json

Retrieves the details of an existing user. You need only supply the unique user identifier that was returned upon user creation.

Parameters

Name In Type Required Description
id path integer true ID of your user.

Example responses

200 Response

[
  {
    "id": 0,
    "object": "string",
    "address_city": "string",
    "address_country": "string",
    "address_line1": "string",
    "address_line2": "string",
    "address_state": "string",
    "address_zipcode": "string",
    "attributes": [],
    "avatar": "string",
    "business_name": "string",
    "can_post_listing": null,
    "created": "2020-11-23T14:57:42Z",
    "email": "string",
    "first_name": "string",
    "group": [
      {
        "object": "string",
        "id": 0,
        "name": "string",
        "alias": "string"
      }
    ],
    "group_alias": "string",
    "group_id": "string",
    "group_name": "string",
    "lang": "string",
    "last_name": "string",
    "locale": "string",
    "note": 0,
    "phone_number": "string",
    "profile_url": "string",
    "public_name": "string",
    "status": "enabled",
    "review_count": 0,
    "timezone": "string",
    "username": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK User with id = {id} Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [User] false none none
» id integer false none none
» object string false none none
» address_city string false none none
» address_country string false none none
» address_line1 string false none none
» address_line2 string false none none
» address_state string false none none
» address_zipcode string false none none
» attributes array false none none
» avatar string false none none
» business_name string false none none
» can_post_listing bool false none none
» created string(date-time) false none none
» email string false none none
» first_name string false none none
» group [Group] false none none
»» object string false none none
»» id integer false none none
»» name string false none none
»» alias string false none none
» group_alias string false none none
» group_id string false none none
» group_name string false none none
» lang string false none none
» last_name string false none none
» locale string false none none
» note integer false none none
» phone_number string false none none
» profile_url string false none none
» public_name string false none none
» status string false none enabled/disabled
» review_count integer false none none
» timezone string false none none
» username string false none none

Enumerated Values

Property Value
status enabled
status disabled

order

List all orders

Code samples

# You can also use wget
curl -X GET https://subdomain.mykreezalid.com/api/v1/orders.json \
  -H 'Accept: application/json'

GET https://subdomain.mykreezalid.com/api/v1/orders.json HTTP/1.1
Host: subdomain.mykreezalid.com
Accept: application/json


const headers = {
  'Accept':'application/json'
};

fetch('https://subdomain.mykreezalid.com/api/v1/orders.json',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://subdomain.mykreezalid.com/api/v1/orders.json',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://subdomain.mykreezalid.com/api/v1/orders.json', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://subdomain.mykreezalid.com/api/v1/orders.json', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://subdomain.mykreezalid.com/api/v1/orders.json");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://subdomain.mykreezalid.com/api/v1/orders.json", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /orders.json

Returns a list of orders previously created. The orders are returned in sorted order, with the most recent orders appearing first.

Parameters

Name In Type Required Description
id query array[string] false ID(s) to filter by

Example responses

200 Response

[
  {
    "id": 0,
    "object": "string",
    "number": "string",
    "order_number": "string",
    "amount": 0,
    "currency": "string",
    "amount_with_currency": 0,
    "status": "string",
    "supplier": {
      "id": 0,
      "object": "string",
      "address_city": "string",
      "address_country": "string",
      "address_line1": "string",
      "address_line2": "string",
      "address_state": "string",
      "address_zipcode": "string",
      "attributes": [],
      "avatar": "string",
      "business_name": "string",
      "can_post_listing": null,
      "created": "2020-11-23T14:57:42Z",
      "email": "string",
      "first_name": "string",
      "group": [
        {
          "object": "string",
          "id": 0,
          "name": "string",
          "alias": "string"
        }
      ],
      "group_alias": "string",
      "group_id": "string",
      "group_name": "string",
      "lang": "string",
      "last_name": "string",
      "locale": "string",
      "note": 0,
      "phone_number": "string",
      "profile_url": "string",
      "public_name": "string",
      "status": "enabled",
      "review_count": 0,
      "timezone": "string",
      "username": "string"
    },
    "customer": {
      "id": 0,
      "object": "string",
      "address_city": "string",
      "address_country": "string",
      "address_line1": "string",
      "address_line2": "string",
      "address_state": "string",
      "address_zipcode": "string",
      "attributes": [],
      "avatar": "string",
      "business_name": "string",
      "can_post_listing": null,
      "created": "2020-11-23T14:57:42Z",
      "email": "string",
      "first_name": "string",
      "group": [
        {
          "object": "string",
          "id": 0,
          "name": "string",
          "alias": "string"
        }
      ],
      "group_alias": "string",
      "group_id": "string",
      "group_name": "string",
      "lang": "string",
      "last_name": "string",
      "locale": "string",
      "note": 0,
      "phone_number": "string",
      "profile_url": "string",
      "public_name": "string",
      "status": "enabled",
      "review_count": 0,
      "timezone": "string",
      "username": "string"
    },
    "customer_url": "string",
    "supplier_url": "string",
    "checkout_at": "2020-11-23T14:57:42Z",
    "shippings": {
      "id": 0,
      "amount": 0,
      "title": "string",
      "tracking_number": "string",
      "tracking_url": "string",
      "address": {
        "id": 0,
        "object": "string",
        "city": "string",
        "country": "string",
        "mobile": "string",
        "name": "string",
        "phone": "string",
        "postcode": "string",
        "state": "string",
        "street": "string",
        "street_option": "string"
      }
    },
    "payout": {
      "status": "string",
      "amount": 0,
      "amount_with_currency": "string",
      "date": "string"
    },
    "smart_fees": [
      {
        "fee_target": "string",
        "rule_title": "string",
        "fee_amount": "string"
      }
    ],
    "order_items": [
      {
        "object": "string",
        "id": 0,
        "add_ons": [
          null
        ],
        "amount": null,
        "configurable_options": [
          null
        ],
        "currency": "string",
        "downloadable_assets": [
          null
        ],
        "listing": {
          "id": 0,
          "object": "string",
          "attributes": [],
          "category": {
            "id": 0,
            "object": "string",
            "title": "string",
            "url": "string"
          },
          "city": "string",
          "country": "string",
          "cover": "string",
          "currency": "string",
          "date_online": "2020-11-23T14:57:42Z",
          "description": "string",
          "external_id": 0,
          "formatted_price": "string",
          "lat": 0,
          "lng": 0,
          "location": "string",
          "medias": "string",
          "price": 0,
          "price_unit": 0,
          "price_with_currency": "string",
          "quantity": 0,
          "quantity_selector": "string",
          "requires_shipping": 0,
          "state": "string",
          "status": "string",
          "user": {
            "id": 0,
            "object": "string",
            "address_city": "string",
            "address_country": "string",
            "address_line1": "string",
            "address_line2": "string",
            "address_state": "string",
            "address_zipcode": "string",
            "attributes": [],
            "avatar": "string",
            "business_name": "string",
            "can_post_listing": null,
            "created": "2020-11-23T14:57:42Z",
            "email": "string",
            "first_name": "string",
            "group": [
              {
                "object": "string",
                "id": 0,
                "name": "string",
                "alias": "string"
              }
            ],
            "group_alias": "string",
            "group_id": "string",
            "group_name": "string",
            "lang": "string",
            "last_name": "string",
            "locale": "string",
            "note": 0,
            "phone_number": "string",
            "profile_url": "string",
            "public_name": "string",
            "status": "enabled",
            "review_count": 0,
            "timezone": "string",
            "username": "string"
          },
          "supplier": {
            "id": 0,
            "object": "string",
            "address_city": "string",
            "address_country": "string",
            "address_line1": "string",
            "address_line2": "string",
            "address_state": "string",
            "address_zipcode": "string",
            "attributes": [],
            "avatar": "string",
            "business_name": "string",
            "can_post_listing": null,
            "created": "2020-11-23T14:57:42Z",
            "email": "string",
            "first_name": "string",
            "group": [
              {
                "object": "string",
                "id": 0,
                "name": "string",
                "alias": "string"
              }
            ],
            "group_alias": "string",
            "group_id": "string",
            "group_name": "string",
            "lang": "string",
            "last_name": "string",
            "locale": "string",
            "note": 0,
            "phone_number": "string",
            "profile_url": "string",
            "public_name": "string",
            "status": "enabled",
            "review_count": 0,
            "timezone": "string",
            "username": "string"
          },
          "title": "string",
          "url": "string",
          "valid_until": "2020-11-23T14:57:42Z",
          "weight": 0
        },
        "listing_id": 0,
        "listing_image": "string",
        "listing_sku": "string",
        "listing_title": "string",
        "listing_unit_price": 0,
        "listing_weight": 0,
        "qty": 0,
        "token": "string"
      }
    ]
  }
]

Responses

Status Meaning Description Schema
200 OK List of all your orders Inline

Response Schema

Status Code 200

List of all orders

Name Type Required Restrictions Description
anonymous [Order] false none List of all orders
» id integer false none none
» object string false none none
» number string false none none
» order_number string false none none
» amount number false none none
» currency string false none none
» amount_with_currency number false none none
» status string false none none
» supplier User false none none
»» id integer false none none
»» object string false none none
»» address_city string false none none
»» address_country string false none none
»» address_line1 string false none none
»» address_line2 string false none none
»» address_state string false none none
»» address_zipcode string false none none
»» attributes array false none none
»» avatar string false none none
»» business_name string false none none
»» can_post_listing bool false none none
»» created string(date-time) false none none
»» email string false none none
»» first_name string false none none
»» group [Group] false none none
»»» object string false none none
»»» id integer false none none
»»» name string false none none
»»» alias string false none none
»» group_alias string false none none
»» group_id string false none none
»» group_name string false none none
»» lang string false none none
»» last_name string false none none
»» locale string false none none
»» note integer false none none
»» phone_number string false none none
»» profile_url string false none none
»» public_name string false none none
»» status string false none enabled/disabled
»» review_count integer false none none
»» timezone string false none none
»» username string false none none
» customer User false none none
» customer_url string false none none
» supplier_url string false none none
» checkout_at string(date-time) false none none
» shippings Shippings false none none
»» id integer false none none
»» amount number false none none
»» title string false none none
»» tracking_number string false none none
»» tracking_url string false none none
»» address object false none none
»»» id integer false none none
»»» object string false none none
»»» city string false none none
»»» country string false none none
»»» mobile string false none none
»»» name string false none First name and last name
»»» phone string false none none
»»» postcode string false none none
»»» state string false none none
»»» street string false none none
»»» street_option string false none none
» payout Payout false none none
»» status string false none none
»» amount integer false none none
»» amount_with_currency string false none none
»» date string(tate-time) false none none
» smart_fees [SmartFees] false none none
»» fee_target string false none none
»» rule_title string false none none
»» fee_amount string false none none
» order_items [OrderItem] false none none
»» object string false none none
»» id integer false none none
»» add_ons [any] false none none
»» amount int false none none
»» configurable_options [any] false none none
»» currency string false none none
»» downloadable_assets [any] false none none
»» listing Listing false none none
»»» id integer false none none
»»» object string false none none
»»» attributes array false none none
»»» category Category false none none
»»»» id integer false none none
»»»» object string false none none
»»»» title string false none none
»»»» url string false none none
»»» city string false none none
»»» country string false none none
»»» cover string false none none
»»» currency string false none none
»»» date_online string(date-time) false none none
»»» description string false none none
»»» external_id integer false none none
»»» formatted_price string false none none
»»» lat number false none none
»»» lng number false none none
»»» location string false none none
»»» medias string false none none
»»» price number false none none
»»» price_unit integer false none none
»»» price_with_currency string false none none
»»» quantity integer false none none
»»» quantity_selector string false none none
»»» requires_shipping integer false none none
»»» state string false none none
»»» status string false none none
»»» user User false none none
»»» supplier User false none none
»»» title string false none none
»»» url string false none none
»»» valid_until string(date-time) false none none
»»» weight number false none none
»» listing_id integer false none none
»» listing_image string false none none
»» listing_sku string false none none
»» listing_title string false none none
»» listing_unit_price number false none none
»» listing_weight number false none none
»» qty number false none none
»» token string false none none

Enumerated Values

Property Value
status enabled
status disabled

Retrieve an order

Code samples

# You can also use wget
curl -X GET https://subdomain.mykreezalid.com/api/v1/orders/{id}.json \
  -H 'Accept: application/json'

GET https://subdomain.mykreezalid.com/api/v1/orders/{id}.json HTTP/1.1
Host: subdomain.mykreezalid.com
Accept: application/json


const headers = {
  'Accept':'application/json'
};

fetch('https://subdomain.mykreezalid.com/api/v1/orders/{id}.json',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://subdomain.mykreezalid.com/api/v1/orders/{id}.json',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://subdomain.mykreezalid.com/api/v1/orders/{id}.json', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://subdomain.mykreezalid.com/api/v1/orders/{id}.json', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("https://subdomain.mykreezalid.com/api/v1/orders/{id}.json");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://subdomain.mykreezalid.com/api/v1/orders/{id}.json", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /orders/{id}.json

View method

Parameters

Name In Type Required Description
id path integer true ID of your order.

Example responses

200 Response

[
  {
    "id": 0,
    "object": "string",
    "number": "string",
    "order_number": "string",
    "amount": 0,
    "currency": "string",
    "amount_with_currency": 0,
    "status": "string",
    "supplier": {
      "id": 0,
      "object": "string",
      "address_city": "string",
      "address_country": "string",
      "address_line1": "string",
      "address_line2": "string",
      "address_state": "string",
      "address_zipcode": "string",
      "attributes": [],
      "avatar": "string",
      "business_name": "string",
      "can_post_listing": null,
      "created": "2020-11-23T14:57:42Z",
      "email": "string",
      "first_name": "string",
      "group": [
        {
          "object": "string",
          "id": 0,
          "name": "string",
          "alias": "string"
        }
      ],
      "group_alias": "string",
      "group_id": "string",
      "group_name": "string",
      "lang": "string",
      "last_name": "string",
      "locale": "string",
      "note": 0,
      "phone_number": "string",
      "profile_url": "string",
      "public_name": "string",
      "status": "enabled",
      "review_count": 0,
      "timezone": "string",
      "username": "string"
    },
    "customer": {
      "id": 0,
      "object": "string",
      "address_city": "string",
      "address_country": "string",
      "address_line1": "string",
      "address_line2": "string",
      "address_state": "string",
      "address_zipcode": "string",
      "attributes": [],
      "avatar": "string",
      "business_name": "string",
      "can_post_listing": null,
      "created": "2020-11-23T14:57:42Z",
      "email": "string",
      "first_name": "string",
      "group": [
        {
          "object": "string",
          "id": 0,
          "name": "string",
          "alias": "string"
        }
      ],
      "group_alias": "string",
      "group_id": "string",
      "group_name": "string",
      "lang": "string",
      "last_name": "string",
      "locale": "string",
      "note": 0,
      "phone_number": "string",
      "profile_url": "string",
      "public_name": "string",
      "status": "enabled",
      "review_count": 0,
      "timezone": "string",
      "username": "string"
    },
    "customer_url": "string",
    "supplier_url": "string",
    "checkout_at": "2020-11-23T14:57:42Z",
    "shippings": {
      "id": 0,
      "amount": 0,
      "title": "string",
      "tracking_number": "string",
      "tracking_url": "string",
      "address": {
        "id": 0,
        "object": "string",
        "city": "string",
        "country": "string",
        "mobile": "string",
        "name": "string",
        "phone": "string",
        "postcode": "string",
        "state": "string",
        "street": "string",
        "street_option": "string"
      }
    },
    "payout": {
      "status": "string",
      "amount": 0,
      "amount_with_currency": "string",
      "date": "string"
    },
    "smart_fees": [
      {
        "fee_target": "string",
        "rule_title": "string",
        "fee_amount": "string"
      }
    ],
    "order_items": [
      {
        "object": "string",
        "id": 0,
        "add_ons": [
          null
        ],
        "amount": null,
        "configurable_options": [
          null
        ],
        "currency": "string",
        "downloadable_assets": [
          null
        ],
        "listing": {
          "id": 0,
          "object": "string",
          "attributes": [],
          "category": {
            "id": 0,
            "object": "string",
            "title": "string",
            "url": "string"
          },
          "city": "string",
          "country": "string",
          "cover": "string",
          "currency": "string",
          "date_online": "2020-11-23T14:57:42Z",
          "description": "string",
          "external_id": 0,
          "formatted_price": "string",
          "lat": 0,
          "lng": 0,
          "location": "string",
          "medias": "string",
          "price": 0,
          "price_unit": 0,
          "price_with_currency": "string",
          "quantity": 0,
          "quantity_selector": "string",
          "requires_shipping": 0,
          "state": "string",
          "status": "string",
          "user": {
            "id": 0,
            "object": "string",
            "address_city": "string",
            "address_country": "string",
            "address_line1": "string",
            "address_line2": "string",
            "address_state": "string",
            "address_zipcode": "string",
            "attributes": [],
            "avatar": "string",
            "business_name": "string",
            "can_post_listing": null,
            "created": "2020-11-23T14:57:42Z",
            "email": "string",
            "first_name": "string",
            "group": [
              {
                "object": "string",
                "id": 0,
                "name": "string",
                "alias": "string"
              }
            ],
            "group_alias": "string",
            "group_id": "string",
            "group_name": "string",
            "lang": "string",
            "last_name": "string",
            "locale": "string",
            "note": 0,
            "phone_number": "string",
            "profile_url": "string",
            "public_name": "string",
            "status": "enabled",
            "review_count": 0,
            "timezone": "string",
            "username": "string"
          },
          "supplier": {
            "id": 0,
            "object": "string",
            "address_city": "string",
            "address_country": "string",
            "address_line1": "string",
            "address_line2": "string",
            "address_state": "string",
            "address_zipcode": "string",
            "attributes": [],
            "avatar": "string",
            "business_name": "string",
            "can_post_listing": null,
            "created": "2020-11-23T14:57:42Z",
            "email": "string",
            "first_name": "string",
            "group": [
              {
                "object": "string",
                "id": 0,
                "name": "string",
                "alias": "string"
              }
            ],
            "group_alias": "string",
            "group_id": "string",
            "group_name": "string",
            "lang": "string",
            "last_name": "string",
            "locale": "string",
            "note": 0,
            "phone_number": "string",
            "profile_url": "string",
            "public_name": "string",
            "status": "enabled",
            "review_count": 0,
            "timezone": "string",
            "username": "string"
          },
          "title": "string",
          "url": "string",
          "valid_until": "2020-11-23T14:57:42Z",
          "weight": 0
        },
        "listing_id": 0,
        "listing_image": "string",
        "listing_sku": "string",
        "listing_title": "string",
        "listing_unit_price": 0,
        "listing_weight": 0,
        "qty": 0,
        "token": "string"
      }
    ]
  }
]

Responses

Status Meaning Description Schema
200 OK Order with id = {id} Inline

Response Schema

Status Code 200

One order

Name Type Required Restrictions Description
anonymous [Order] false none One order
» id integer false none none
» object string false none none
» number string false none none
» order_number string false none none
» amount number false none none
» currency string false none none
» amount_with_currency number false none none
» status string false none none
» supplier User false none none
»» id integer false none none
»» object string false none none
»» address_city string false none none
»» address_country string false none none
»» address_line1 string false none none
»» address_line2 string false none none
»» address_state string false none none
»» address_zipcode string false none none
»» attributes array false none none
»» avatar string false none none
»» business_name string false none none
»» can_post_listing bool false none none
»» created string(date-time) false none none
»» email string false none none
»» first_name string false none none
»» group [Group] false none none
»»» object string false none none
»»» id integer false none none
»»» name string false none none
»»» alias string false none none
»» group_alias string false none none
»» group_id string false none none
»» group_name string false none none
»» lang string false none none
»» last_name string false none none
»» locale string false none none
»» note integer false none none
»» phone_number string false none none
»» profile_url string false none none
»» public_name string false none none
»» status string false none enabled/disabled
»» review_count integer false none none
»» timezone string false none none
»» username string false none none
» customer User false none none
» customer_url string false none none
» supplier_url string false none none
» checkout_at string(date-time) false none none
» shippings Shippings false none none
»» id integer false none none
»» amount number false none none
»» title string false none none
»» tracking_number string false none none
»» tracking_url string false none none
»» address object false none none
»»» id integer false none none
»»» object string false none none
»»» city string false none none
»»» country string false none none
»»» mobile string false none none
»»» name string false none First name and last name
»»» phone string false none none
»»» postcode string false none none
»»» state string false none none
»»» street string false none none
»»» street_option string false none none
» payout Payout false none none
»» status string false none none
»» amount integer false none none
»» amount_with_currency string false none none
»» date string(tate-time) false none none
» smart_fees [SmartFees] false none none
»» fee_target string false none none
»» rule_title string false none none
»» fee_amount string false none none
» order_items [OrderItem] false none none
»» object string false none none
»» id integer false none none
»» add_ons [any] false none none
»» amount int false none none
»» configurable_options [any] false none none
»» currency string false none none
»» downloadable_assets [any] false none none
»» listing Listing false none none
»»» id integer false none none
»»» object string false none none
»»» attributes array false none none
»»» category Category false none none
»»»» id integer false none none
»»»» object string false none none
»»»» title string false none none
»»»» url string false none none
»»» city string false none none
»»» country string false none none
»»» cover string false none none
»»» currency string false none none
»»» date_online string(date-time) false none none
»»» description string false none none
»»» external_id integer false none none
»»» formatted_price string false none none
»»» lat number false none none
»»» lng number false none none
»»» location string false none none
»»» medias string false none none
»»» price number false none none
»»» price_unit integer false none none
»»» price_with_currency string false none none
»»» quantity integer false none none
»»» quantity_selector string false none none
»»» requires_shipping integer false none none
»»» state string false none none
»»» status string false none none
»»» user User false none none
»»» supplier User false none none
»»» title string false none none
»»» url string false none none
»»» valid_until string(date-time) false none none
»»» weight number false none none
»» listing_id integer false none none
»» listing_image string false none none
»» listing_sku string false none none
»» listing_title string false none none
»» listing_unit_price number false none none
»» listing_weight number false none none
»» qty number false none none
»» token string false none none

Enumerated Values

Property Value
status enabled
status disabled

Schemas

AddOn

{
  "id": 0,
  "addon_id": 0,
  "addon_title": 0,
  "addon_qty": 0,
  "addon_unit_price": 0,
  "app_id": 0,
  "created": "2020-11-23T14:57:42Z",
  "deleted_at": "2020-11-23T14:57:42Z",
  "item_id": 0,
  "listing": {
    "id": 0,
    "object": "string",
    "attributes": [],
    "category": {
      "id": 0,
      "object": "string",
      "title": "string",
      "url": "string"
    },
    "city": "string",
    "country": "string",
    "cover": "string",
    "currency": "string",
    "date_online": "2020-11-23T14:57:42Z",
    "description": "string",
    "external_id": 0,
    "formatted_price": "string",
    "lat": 0,
    "lng": 0,
    "location": "string",
    "medias": "string",
    "price": 0,
    "price_unit": 0,
    "price_with_currency": "string",
    "quantity": 0,
    "quantity_selector": "string",
    "requires_shipping": 0,
    "state": "string",
    "status": "string",
    "user": {
      "id": 0,
      "object": "string",
      "address_city": "string",
      "address_country": "string",
      "address_line1": "string",
      "address_line2": "string",
      "address_state": "string",
      "address_zipcode": "string",
      "attributes": [],
      "avatar": "string",
      "business_name": "string",
      "can_post_listing": null,
      "created": "2020-11-23T14:57:42Z",
      "email": "string",
      "first_name": "string",
      "group": [
        {
          "object": "string",
          "id": 0,
          "name": "string",
          "alias": "string"
        }
      ],
      "group_alias": "string",
      "group_id": "string",
      "group_name": "string",
      "lang": "string",
      "last_name": "string",
      "locale": "string",
      "note": 0,
      "phone_number": "string",
      "profile_url": "string",
      "public_name": "string",
      "status": "enabled",
      "review_count": 0,
      "timezone": "string",
      "username": "string"
    },
    "supplier": {
      "id": 0,
      "object": "string",
      "address_city": "string",
      "address_country": "string",
      "address_line1": "string",
      "address_line2": "string",
      "address_state": "string",
      "address_zipcode": "string",
      "attributes": [],
      "avatar": "string",
      "business_name": "string",
      "can_post_listing": null,
      "created": "2020-11-23T14:57:42Z",
      "email": "string",
      "first_name": "string",
      "group": [
        {
          "object": "string",
          "id": 0,
          "name": "string",
          "alias": "string"
        }
      ],
      "group_alias": "string",
      "group_id": "string",
      "group_name": "string",
      "lang": "string",
      "last_name": "string",
      "locale": "string",
      "note": 0,
      "phone_number": "string",
      "profile_url": "string",
      "public_name": "string",
      "status": "enabled",
      "review_count": 0,
      "timezone": "string",
      "username": "string"
    },
    "title": "string",
    "url": "string",
    "valid_until": "2020-11-23T14:57:42Z",
    "weight": 0
  },
  "listing_id": 0,
  "modified": "2020-11-23T14:57:42Z",
  "old_id": 0,
  "order": {
    "id": 0,
    "object": "string",
    "number": "string",
    "order_number": "string",
    "amount": 0,
    "currency": "string",
    "amount_with_currency": 0,
    "status": "string",
    "supplier": {
      "id": 0,
      "object": "string",
      "address_city": "string",
      "address_country": "string",
      "address_line1": "string",
      "address_line2": "string",
      "address_state": "string",
      "address_zipcode": "string",
      "attributes": [],
      "avatar": "string",
      "business_name": "string",
      "can_post_listing": null,
      "created": "2020-11-23T14:57:42Z",
      "email": "string",
      "first_name": "string",
      "group": [
        {
          "object": "string",
          "id": 0,
          "name": "string",
          "alias": "string"
        }
      ],
      "group_alias": "string",
      "group_id": "string",
      "group_name": "string",
      "lang": "string",
      "last_name": "string",
      "locale": "string",
      "note": 0,
      "phone_number": "string",
      "profile_url": "string",
      "public_name": "string",
      "status": "enabled",
      "review_count": 0,
      "timezone": "string",
      "username": "string"
    },
    "customer": {
      "id": 0,
      "object": "string",
      "address_city": "string",
      "address_country": "string",
      "address_line1": "string",
      "address_line2": "string",
      "address_state": "string",
      "address_zipcode": "string",
      "attributes": [],
      "avatar": "string",
      "business_name": "string",
      "can_post_listing": null,
      "created": "2020-11-23T14:57:42Z",
      "email": "string",
      "first_name": "string",
      "group": [
        {
          "object": "string",
          "id": 0,
          "name": "string",
          "alias": "string"
        }
      ],
      "group_alias": "string",
      "group_id": "string",
      "group_name": "string",
      "lang": "string",
      "last_name": "string",
      "locale": "string",
      "note": 0,
      "phone_number": "string",
      "profile_url": "string",
      "public_name": "string",
      "status": "enabled",
      "review_count": 0,
      "timezone": "string",
      "username": "string"
    },
    "customer_url": "string",
    "supplier_url": "string",
    "checkout_at": "2020-11-23T14:57:42Z",
    "shippings": {
      "id": 0,
      "amount": 0,
      "title": "string",
      "tracking_number": "string",
      "tracking_url": "string",
      "address": {
        "id": 0,
        "object": "string",
        "city": "string",
        "country": "string",
        "mobile": "string",
        "name": "string",
        "phone": "string",
        "postcode": "string",
        "state": "string",
        "street": "string",
        "street_option": "string"
      }
    },
    "payout": {
      "status": "string",
      "amount": 0,
      "amount_with_currency": "string",
      "date": "string"
    },
    "smart_fees": [
      {
        "fee_target": "string",
        "rule_title": "string",
        "fee_amount": "string"
      }
    ],
    "order_items": [
      {
        "object": "string",
        "id": 0,
        "add_ons": [
          null
        ],
        "amount": null,
        "configurable_options": [
          null
        ],
        "currency": "string",
        "downloadable_assets": [
          null
        ],
        "listing": {
          "id": 0,
          "object": "string",
          "attributes": [],
          "category": {
            "id": 0,
            "object": "string",
            "title": "string",
            "url": "string"
          },
          "city": "string",
          "country": "string",
          "cover": "string",
          "currency": "string",
          "date_online": "2020-11-23T14:57:42Z",
          "description": "string",
          "external_id": 0,
          "formatted_price": "string",
          "lat": 0,
          "lng": 0,
          "location": "string",
          "medias": "string",
          "price": 0,
          "price_unit": 0,
          "price_with_currency": "string",
          "quantity": 0,
          "quantity_selector": "string",
          "requires_shipping": 0,
          "state": "string",
          "status": "string",
          "user": {
            "id": 0,
            "object": "string",
            "address_city": "string",
            "address_country": "string",
            "address_line1": "string",
            "address_line2": "string",
            "address_state": "string",
            "address_zipcode": "string",
            "attributes": [],
            "avatar": "string",
            "business_name": "string",
            "can_post_listing": null,
            "created": "2020-11-23T14:57:42Z",
            "email": "string",
            "first_name": "string",
            "group": [
              {
                "object": "string",
                "id": 0,
                "name": "string",
                "alias": "string"
              }
            ],
            "group_alias": "string",
            "group_id": "string",
            "group_name": "string",
            "lang": "string",
            "last_name": "string",
            "locale": "string",
            "note": 0,
            "phone_number": "string",
            "profile_url": "string",
            "public_name": "string",
            "status": "enabled",
            "review_count": 0,
            "timezone": "string",
            "username": "string"
          },
          "supplier": {
            "id": 0,
            "object": "string",
            "address_city": "string",
            "address_country": "string",
            "address_line1": "string",
            "address_line2": "string",
            "address_state": "string",
            "address_zipcode": "string",
            "attributes": [],
            "avatar": "string",
            "business_name": "string",
            "can_post_listing": null,
            "created": "2020-11-23T14:57:42Z",
            "email": "string",
            "first_name": "string",
            "group": [
              {
                "object": "string",
                "id": 0,
                "name": "string",
                "alias": "string"
              }
            ],
            "group_alias": "string",
            "group_id": "string",
            "group_name": "string",
            "lang": "string",
            "last_name": "string",
            "locale": "string",
            "note": 0,
            "phone_number": "string",
            "profile_url": "string",
            "public_name": "string",
            "status": "enabled",
            "review_count": 0,
            "timezone": "string",
            "username": "string"
          },
          "title": "string",
          "url": "string",
          "valid_until": "2020-11-23T14:57:42Z",
          "weight": 0
        },
        "listing_id": 0,
        "listing_image": "string",
        "listing_sku": "string",
        "listing_title": "string",
        "listing_unit_price": 0,
        "listing_weight": 0,
        "qty": 0,
        "token": "string"
      }
    ]
  },
  "order_id": 0,
  "sort_priority": 0
}

Properties

Name Type Required Restrictions Description
id integer false none none
addon_id integer false none none
addon_title number false none none
addon_qty number false none none
addon_unit_price number false none none
app_id integer false none none
created string(date-time) false none none
deleted_at string(date-time) false none none
item_id integer false none none
listing Listing false none none
listing_id integer false none none
modified string(date-time) false none none
old_id integer false none none
order Order false none none
order_id integer false none none
sort_priority integer false none none

Category

{
  "id": 0,
  "object": "string",
  "title": "string",
  "url": "string"
}

Properties

Name Type Required Restrictions Description
id integer false none none
object string false none none
title string false none none
url string false none none

Group

{
  "object": "string",
  "id": 0,
  "name": "string",
  "alias": "string"
}

Properties

Name Type Required Restrictions Description
object string false none none
id integer false none none
name string false none none
alias string false none none

Listing

{
  "id": 0,
  "object": "string",
  "attributes": [],
  "category": {
    "id": 0,
    "object": "string",
    "title": "string",
    "url": "string"
  },
  "city": "string",
  "country": "string",
  "cover": "string",
  "currency": "string",
  "date_online": "2020-11-23T14:57:42Z",
  "description": "string",
  "external_id": 0,
  "formatted_price": "string",
  "lat": 0,
  "lng": 0,
  "location": "string",
  "medias": "string",
  "price": 0,
  "price_unit": 0,
  "price_with_currency": "string",
  "quantity": 0,
  "quantity_selector": "string",
  "requires_shipping": 0,
  "state": "string",
  "status": "string",
  "user": {
    "id": 0,
    "object": "string",
    "address_city": "string",
    "address_country": "string",
    "address_line1": "string",
    "address_line2": "string",
    "address_state": "string",
    "address_zipcode": "string",
    "attributes": [],
    "avatar": "string",
    "business_name": "string",
    "can_post_listing": null,
    "created": "2020-11-23T14:57:42Z",
    "email": "string",
    "first_name": "string",
    "group": [
      {
        "object": "string",
        "id": 0,
        "name": "string",
        "alias": "string"
      }
    ],
    "group_alias": "string",
    "group_id": "string",
    "group_name": "string",
    "lang": "string",
    "last_name": "string",
    "locale": "string",
    "note": 0,
    "phone_number": "string",
    "profile_url": "string",
    "public_name": "string",
    "status": "enabled",
    "review_count": 0,
    "timezone": "string",
    "username": "string"
  },
  "supplier": {
    "id": 0,
    "object": "string",
    "address_city": "string",
    "address_country": "string",
    "address_line1": "string",
    "address_line2": "string",
    "address_state": "string",
    "address_zipcode": "string",
    "attributes": [],
    "avatar": "string",
    "business_name": "string",
    "can_post_listing": null,
    "created": "2020-11-23T14:57:42Z",
    "email": "string",
    "first_name": "string",
    "group": [
      {
        "object": "string",
        "id": 0,
        "name": "string",
        "alias": "string"
      }
    ],
    "group_alias": "string",
    "group_id": "string",
    "group_name": "string",
    "lang": "string",
    "last_name": "string",
    "locale": "string",
    "note": 0,
    "phone_number": "string",
    "profile_url": "string",
    "public_name": "string",
    "status": "enabled",
    "review_count": 0,
    "timezone": "string",
    "username": "string"
  },
  "title": "string",
  "url": "string",
  "valid_until": "2020-11-23T14:57:42Z",
  "weight": 0
}

Properties

Name Type Required Restrictions Description
id integer false none none
object string false none none
attributes array false none none
category Category false none none
city string false none none
country string false none none
cover string false none none
currency string false none none
date_online string(date-time) false none none
description string false none none
external_id integer false none none
formatted_price string false none none
lat number false none none
lng number false none none
location string false none none
medias string false none none
price number false none none
price_unit integer false none none
price_with_currency string false none none
quantity integer false none none
quantity_selector string false none none
requires_shipping integer false none none
state string false none none
status string false none none
user User false none none
supplier User false none none
title string false none none
url string false none none
valid_until string(date-time) false none none
weight number false none none

Order

{
  "id": 0,
  "object": "string",
  "number": "string",
  "order_number": "string",
  "amount": 0,
  "currency": "string",
  "amount_with_currency": 0,
  "status": "string",
  "supplier": {
    "id": 0,
    "object": "string",
    "address_city": "string",
    "address_country": "string",
    "address_line1": "string",
    "address_line2": "string",
    "address_state": "string",
    "address_zipcode": "string",
    "attributes": [],
    "avatar": "string",
    "business_name": "string",
    "can_post_listing": null,
    "created": "2020-11-23T14:57:42Z",
    "email": "string",
    "first_name": "string",
    "group": [
      {
        "object": "string",
        "id": 0,
        "name": "string",
        "alias": "string"
      }
    ],
    "group_alias": "string",
    "group_id": "string",
    "group_name": "string",
    "lang": "string",
    "last_name": "string",
    "locale": "string",
    "note": 0,
    "phone_number": "string",
    "profile_url": "string",
    "public_name": "string",
    "status": "enabled",
    "review_count": 0,
    "timezone": "string",
    "username": "string"
  },
  "customer": {
    "id": 0,
    "object": "string",
    "address_city": "string",
    "address_country": "string",
    "address_line1": "string",
    "address_line2": "string",
    "address_state": "string",
    "address_zipcode": "string",
    "attributes": [],
    "avatar": "string",
    "business_name": "string",
    "can_post_listing": null,
    "created": "2020-11-23T14:57:42Z",
    "email": "string",
    "first_name": "string",
    "group": [
      {
        "object": "string",
        "id": 0,
        "name": "string",
        "alias": "string"
      }
    ],
    "group_alias": "string",
    "group_id": "string",
    "group_name": "string",
    "lang": "string",
    "last_name": "string",
    "locale": "string",
    "note": 0,
    "phone_number": "string",
    "profile_url": "string",
    "public_name": "string",
    "status": "enabled",
    "review_count": 0,
    "timezone": "string",
    "username": "string"
  },
  "customer_url": "string",
  "supplier_url": "string",
  "checkout_at": "2020-11-23T14:57:42Z",
  "shippings": {
    "id": 0,
    "amount": 0,
    "title": "string",
    "tracking_number": "string",
    "tracking_url": "string",
    "address": {
      "id": 0,
      "object": "string",
      "city": "string",
      "country": "string",
      "mobile": "string",
      "name": "string",
      "phone": "string",
      "postcode": "string",
      "state": "string",
      "street": "string",
      "street_option": "string"
    }
  },
  "payout": {
    "status": "string",
    "amount": 0,
    "amount_with_currency": "string",
    "date": "string"
  },
  "smart_fees": [
    {
      "fee_target": "string",
      "rule_title": "string",
      "fee_amount": "string"
    }
  ],
  "order_items": [
    {
      "object": "string",
      "id": 0,
      "add_ons": [
        null
      ],
      "amount": null,
      "configurable_options": [
        null
      ],
      "currency": "string",
      "downloadable_assets": [
        null
      ],
      "listing": {
        "id": 0,
        "object": "string",
        "attributes": [],
        "category": {
          "id": 0,
          "object": "string",
          "title": "string",
          "url": "string"
        },
        "city": "string",
        "country": "string",
        "cover": "string",
        "currency": "string",
        "date_online": "2020-11-23T14:57:42Z",
        "description": "string",
        "external_id": 0,
        "formatted_price": "string",
        "lat": 0,
        "lng": 0,
        "location": "string",
        "medias": "string",
        "price": 0,
        "price_unit": 0,
        "price_with_currency": "string",
        "quantity": 0,
        "quantity_selector": "string",
        "requires_shipping": 0,
        "state": "string",
        "status": "string",
        "user": {
          "id": 0,
          "object": "string",
          "address_city": "string",
          "address_country": "string",
          "address_line1": "string",
          "address_line2": "string",
          "address_state": "string",
          "address_zipcode": "string",
          "attributes": [],
          "avatar": "string",
          "business_name": "string",
          "can_post_listing": null,
          "created": "2020-11-23T14:57:42Z",
          "email": "string",
          "first_name": "string",
          "group": [
            {
              "object": "string",
              "id": 0,
              "name": "string",
              "alias": "string"
            }
          ],
          "group_alias": "string",
          "group_id": "string",
          "group_name": "string",
          "lang": "string",
          "last_name": "string",
          "locale": "string",
          "note": 0,
          "phone_number": "string",
          "profile_url": "string",
          "public_name": "string",
          "status": "enabled",
          "review_count": 0,
          "timezone": "string",
          "username": "string"
        },
        "supplier": {
          "id": 0,
          "object": "string",
          "address_city": "string",
          "address_country": "string",
          "address_line1": "string",
          "address_line2": "string",
          "address_state": "string",
          "address_zipcode": "string",
          "attributes": [],
          "avatar": "string",
          "business_name": "string",
          "can_post_listing": null,
          "created": "2020-11-23T14:57:42Z",
          "email": "string",
          "first_name": "string",
          "group": [
            {
              "object": "string",
              "id": 0,
              "name": "string",
              "alias": "string"
            }
          ],
          "group_alias": "string",
          "group_id": "string",
          "group_name": "string",
          "lang": "string",
          "last_name": "string",
          "locale": "string",
          "note": 0,
          "phone_number": "string",
          "profile_url": "string",
          "public_name": "string",
          "status": "enabled",
          "review_count": 0,
          "timezone": "string",
          "username": "string"
        },
        "title": "string",
        "url": "string",
        "valid_until": "2020-11-23T14:57:42Z",
        "weight": 0
      },
      "listing_id": 0,
      "listing_image": "string",
      "listing_sku": "string",
      "listing_title": "string",
      "listing_unit_price": 0,
      "listing_weight": 0,
      "qty": 0,
      "token": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
id integer false none none
object string false none none
number string false none none
order_number string false none none
amount number false none none
currency string false none none
amount_with_currency number false none none
status string false none none
supplier User false none none
customer User false none none
customer_url string false none none
supplier_url string false none none
checkout_at string(date-time) false none none
shippings Shippings false none none
payout Payout false none none
smart_fees [SmartFees] false none none
order_items [OrderItem] false none none

OrderItem

{
  "object": "string",
  "id": 0,
  "add_ons": [
    null
  ],
  "amount": null,
  "configurable_options": [
    null
  ],
  "currency": "string",
  "downloadable_assets": [
    null
  ],
  "listing": {
    "id": 0,
    "object": "string",
    "attributes": [],
    "category": {
      "id": 0,
      "object": "string",
      "title": "string",
      "url": "string"
    },
    "city": "string",
    "country": "string",
    "cover": "string",
    "currency": "string",
    "date_online": "2020-11-23T14:57:42Z",
    "description": "string",
    "external_id": 0,
    "formatted_price": "string",
    "lat": 0,
    "lng": 0,
    "location": "string",
    "medias": "string",
    "price": 0,
    "price_unit": 0,
    "price_with_currency": "string",
    "quantity": 0,
    "quantity_selector": "string",
    "requires_shipping": 0,
    "state": "string",
    "status": "string",
    "user": {
      "id": 0,
      "object": "string",
      "address_city": "string",
      "address_country": "string",
      "address_line1": "string",
      "address_line2": "string",
      "address_state": "string",
      "address_zipcode": "string",
      "attributes": [],
      "avatar": "string",
      "business_name": "string",
      "can_post_listing": null,
      "created": "2020-11-23T14:57:42Z",
      "email": "string",
      "first_name": "string",
      "group": [
        {
          "object": "string",
          "id": 0,
          "name": "string",
          "alias": "string"
        }
      ],
      "group_alias": "string",
      "group_id": "string",
      "group_name": "string",
      "lang": "string",
      "last_name": "string",
      "locale": "string",
      "note": 0,
      "phone_number": "string",
      "profile_url": "string",
      "public_name": "string",
      "status": "enabled",
      "review_count": 0,
      "timezone": "string",
      "username": "string"
    },
    "supplier": {
      "id": 0,
      "object": "string",
      "address_city": "string",
      "address_country": "string",
      "address_line1": "string",
      "address_line2": "string",
      "address_state": "string",
      "address_zipcode": "string",
      "attributes": [],
      "avatar": "string",
      "business_name": "string",
      "can_post_listing": null,
      "created": "2020-11-23T14:57:42Z",
      "email": "string",
      "first_name": "string",
      "group": [
        {
          "object": "string",
          "id": 0,
          "name": "string",
          "alias": "string"
        }
      ],
      "group_alias": "string",
      "group_id": "string",
      "group_name": "string",
      "lang": "string",
      "last_name": "string",
      "locale": "string",
      "note": 0,
      "phone_number": "string",
      "profile_url": "string",
      "public_name": "string",
      "status": "enabled",
      "review_count": 0,
      "timezone": "string",
      "username": "string"
    },
    "title": "string",
    "url": "string",
    "valid_until": "2020-11-23T14:57:42Z",
    "weight": 0
  },
  "listing_id": 0,
  "listing_image": "string",
  "listing_sku": "string",
  "listing_title": "string",
  "listing_unit_price": 0,
  "listing_weight": 0,
  "qty": 0,
  "token": "string"
}

Properties

Name Type Required Restrictions Description
object string false none none
id integer false none none
add_ons [any] false none none
amount int false none none
configurable_options [any] false none none
currency string false none none
downloadable_assets [any] false none none
listing Listing false none none
listing_id integer false none none
listing_image string false none none
listing_sku string false none none
listing_title string false none none
listing_unit_price number false none none
listing_weight number false none none
qty number false none none
token string false none none

Payout

{
  "status": "string",
  "amount": 0,
  "amount_with_currency": "string",
  "date": "string"
}

Properties

Name Type Required Restrictions Description
status string false none none
amount integer false none none
amount_with_currency string false none none
date string(tate-time) false none none

Shippings

{
  "id": 0,
  "amount": 0,
  "title": "string",
  "tracking_number": "string",
  "tracking_url": "string",
  "address": {
    "id": 0,
    "object": "string",
    "city": "string",
    "country": "string",
    "mobile": "string",
    "name": "string",
    "phone": "string",
    "postcode": "string",
    "state": "string",
    "street": "string",
    "street_option": "string"
  }
}

Properties

Name Type Required Restrictions Description
id integer false none none
amount number false none none
title string false none none
tracking_number string false none none
tracking_url string false none none
address object false none none
» id integer false none none
» object string false none none
» city string false none none
» country string false none none
» mobile string false none none
» name string false none First name and last name
» phone string false none none
» postcode string false none none
» state string false none none
» street string false none none
» street_option string false none none

SmartFees

{
  "fee_target": "string",
  "rule_title": "string",
  "fee_amount": "string"
}

Properties

Name Type Required Restrictions Description
fee_target string false none none
rule_title string false none none
fee_amount string false none none

User

{
  "id": 0,
  "object": "string",
  "address_city": "string",
  "address_country": "string",
  "address_line1": "string",
  "address_line2": "string",
  "address_state": "string",
  "address_zipcode": "string",
  "attributes": [],
  "avatar": "string",
  "business_name": "string",
  "can_post_listing": null,
  "created": "2020-11-23T14:57:42Z",
  "email": "string",
  "first_name": "string",
  "group": [
    {
      "object": "string",
      "id": 0,
      "name": "string",
      "alias": "string"
    }
  ],
  "group_alias": "string",
  "group_id": "string",
  "group_name": "string",
  "lang": "string",
  "last_name": "string",
  "locale": "string",
  "note": 0,
  "phone_number": "string",
  "profile_url": "string",
  "public_name": "string",
  "status": "enabled",
  "review_count": 0,
  "timezone": "string",
  "username": "string"
}

Properties

Name Type Required Restrictions Description
id integer false none none
object string false none none
address_city string false none none
address_country string false none none
address_line1 string false none none
address_line2 string false none none
address_state string false none none
address_zipcode string false none none
attributes array false none none
avatar string false none none
business_name string false none none
can_post_listing bool false none none
created string(date-time) false none none
email string false none none
first_name string false none none
group [Group] false none none
group_alias string false none none
group_id string false none none
group_name string false none none
lang string false none none
last_name string false none none
locale string false none none
note integer false none none
phone_number string false none none
profile_url string false none none
public_name string false none none
status string false none enabled/disabled
review_count integer false none none
timezone string false none none
username string false none none

Enumerated Values

Property Value
status enabled
status disabled