API Reference

Create Team

Use to create a team.

OUTPUT PARAMS

success

boolean

Indicates whether the service completed successfully.

  • false - the service failed.
  • true - the service succeeded.

rc

Int32

If an error occurred, the return code.

message

string

If an error occurred, a message indicating the error.

id

Int32

The Id of the new team.

address

string

The of this team.

beacon_ids

Array of strings

An array of Ids for the beacons associated with the team.

contact_phone

string

The contact phone number associated with this team.

country_code

string

The country code of this team. The maximum length is 255 characters.

created_at

datetime

The date and time this team was created. This is in UTC in the format is "%Y-%m-%dT%H:%M:%S%z"

default_customer_id

Int32

The default customer Id of this team.

default_user_id

Int32

The default user (driver) Id for this team.

delete_at

datetime

The date and time this team was deleted This is in UTC in the format is "%Y-%m-%dT%H:%M:%S%z"

description

string

The description of this team.

distance_pay_per_km

float

The distance pay per kilometer for this team.

external_id

string

The team's external Id.

extra

Object

Internal use.

extras

Object

Internal use.

geohash

string

The geohash (public domain geocoding system hash) of this team.

home_area

Object

An object containing the home areas for this team.

lat

float

The geoposition latitude of the team's address.

lng

float

The geoposition longitude of the team's address.

merchant_id

Int32

The Id of the company. The merchant_id may be null, if the developer works with only one company.

name

string

The name of this team.

parent_team_id

Int32

The Id of the parent team with which this team is associated.

printer_type

string

The type of printer used to print receipts. The values are:

  • 3"
  • A4

required_coc_type

Int32

The required chain of custody type. The values include:

  • 0 - weak
  • 1 - strong
  • 2 - none
  • 3 - unload

service_boroughs

Array of text

An array of boroughs serviced by this team.

service_cities

Array of text

An array of cities serviced by this team.

service_zipcodes

Array of text

An array of ZIP Codes serviced by this team.

time_zone

string

The time zone of the team.

updated_at

datetime

The last update date and time for this team. This is in UTC in the format is "%Y-%m-%dT%H:%M:%S%z"

zipcode

string

The ZIP Code of this team.

Language