GET misc/carriers?session={session}&options={options}

GET misc/carriers?session={session}&options={options}

Carrier list

Request

URL parameters

NameDescriptionTypeAdditionnal InformationIntro version
session Identification de la session. (Doit ĂȘtre unique pour la session en cours) string Length between 0 and 100
options Options pour traitements personalisés string Length between 0 and 100

Response

CarrierResult
NameDescriptionTypeAdditionnal InformationIntro version
carrier Order list Collection of Carrier
returncode Return code: 0 for success integer
returnmsg Return message string
warnings Warnings (the instruction worked but you need to pay attention to warnings. May cause partial data loss (Truncation)) Collection of string
version API version string

Return format

application/json, text/json, application/x-www-form-urlencoded

Sample:
{
  "carrier": [
    {
      "carrier_id": 1,
      "carriercode": "sample string 2",
      "carriername_fr": "sample string 3",
      "carriername_en": "sample string 4",
      "carriertype": "sample string 5"
    },
    {
      "carrier_id": 1,
      "carriercode": "sample string 2",
      "carriername_fr": "sample string 3",
      "carriername_en": "sample string 4",
      "carriertype": "sample string 5"
    }
  ],
  "returncode": 1,
  "returnmsg": "sample string 2",
  "warnings": [
    "sample string 1",
    "sample string 2"
  ],
  "version": "sample string 3"
}

application/xml, text/xml

Sample:
<result returncode="1" returnmsg="sample string 2" version="sample string 3">
  <warnings>sample string 1</warnings>
  <warnings>sample string 2</warnings>
  <carrier carrier_id="1" carriercode="sample string 2" carriername_fr="sample string 3" carriername_en="sample string 4" carriertype="sample string 5" />
  <carrier carrier_id="1" carriercode="sample string 2" carriername_fr="sample string 3" carriername_en="sample string 4" carriertype="sample string 5" />
</result>

© 2024 - Acceo Solutions inc.