Introduction

Base URL: https://system.skladusa.com

Welcome to our API documentation!

Authenticating requests

This API is not authenticated.

Products

Display a listing of the products.

Example request:

$client = new \GuzzleHttp\Client();
$url = 'https://system.skladusa.com/api/product';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'Authorization' => 'required    Basic + base64 encoded \'user_id:api_token\'',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://system.skladusa.com/api/product"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": "required    Basic + base64 encoded &#039;user_id:api_token&#039;",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

curl --request GET \
    --get "https://system.skladusa.com/api/product" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: required    Basic + base64 encoded \&#039;user_id:api_token\&#039;"

Example response (200):


{
"data": {
"entities": [
  {
     "product": {
         "id": 85,
         "name": "Monica Panek",
         "title": "Monica Panek",
         "upc": "Monica Panek",
         "sku": "Monica Panek2",
         "productPacketType": 0
     }
  },
 ..............................
 ]
 },
"status": "success"
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Display the specified product resource.

Example request:

$client = new \GuzzleHttp\Client();
$url = 'https://system.skladusa.com/api/product/ut';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'Authorization' => 'required    Basic + base64 encoded \'user_id:api_token\'',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://system.skladusa.com/api/product/ut"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": "required    Basic + base64 encoded &#039;user_id:api_token&#039;",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

curl --request GET \
    --get "https://system.skladusa.com/api/product/ut" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: required    Basic + base64 encoded \&#039;user_id:api_token\&#039;"

Example response (200):


{
    "data": {
        "product": {
            "id": 85,
            "name": "Monica Panek",
            "title": "Monica Panek",
            "upc": "Monica Panek",
            "sku": "Monica Panek2",
            "productPacketType": 0
        }
    },
    "status": "success"
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET /api/product/{id}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Authorization

Example: required Basic + base64 encoded 'user_id:api_token'

URL Parameters

id string

The ID of the product. Example: ut

productId integer optional

Product Id. Example: 12

Store a newly created product.

Example request:

$client = new \GuzzleHttp\Client();
$url = 'https://system.skladusa.com/api/product';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'Authorization' => 'required    Basic + base64 encoded \'user_id:api_token\'',
        ],
        'json' => [
            'name' => 'aut',
            'title' => 'fugit',
            'upc' => 'id',
            'sku' => 'non',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://system.skladusa.com/api/product"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": "required    Basic + base64 encoded &#039;user_id:api_token&#039;",
};

let body = {
    "name": "aut",
    "title": "fugit",
    "upc": "id",
    "sku": "non"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request PUT \
    "https://system.skladusa.com/api/product" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: required    Basic + base64 encoded \&#039;user_id:api_token\&#039;" \
    --data "{
    \"name\": \"aut\",
    \"title\": \"fugit\",
    \"upc\": \"id\",
    \"sku\": \"non\"
}"

Example response (200):


{
    "data": {
        "id": 87
    },
    "status": "success"
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PUT /api/product

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Authorization

Example: required Basic + base64 encoded 'user_id:api_token'

Body Parameters

name string

Dusty blue white flower comb Bride Bridesmaid floral hair piece Fall wedding hair accessories Example: aut

title string

Dusty blue white flower comb Bride Bridesmaid floral hair piece Fall wedding hair accessories Example: fugit

upc string

B073QK9LZX Example: id

sku string

B072KG8H4M, BT-F10M-HAER Example: non

Update the specified product resource in storage.

Example request:

$client = new \GuzzleHttp\Client();
$url = 'https://system.skladusa.com/api/product/molestiae';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'Authorization' => 'required    Basic + base64 encoded \'user_id:api_token\'',
        ],
        'json' => [
            'name' => 'dolores',
            'title' => 'qui',
            'upc' => 'aut',
            'sku' => 'magni',
            'productPacketType' => false,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://system.skladusa.com/api/product/molestiae"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": "required    Basic + base64 encoded &#039;user_id:api_token&#039;",
};

let body = {
    "name": "dolores",
    "title": "qui",
    "upc": "aut",
    "sku": "magni",
    "productPacketType": false
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "https://system.skladusa.com/api/product/molestiae" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: required    Basic + base64 encoded \&#039;user_id:api_token\&#039;" \
    --data "{
    \"name\": \"dolores\",
    \"title\": \"qui\",
    \"upc\": \"aut\",
    \"sku\": \"magni\",
    \"productPacketType\": false
}"

Example response (200):


{
    "data": [
        "Somehow valid"
    ],
    "status": "success"
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST /api/product/{id}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Authorization

Example: required Basic + base64 encoded 'user_id:api_token'

URL Parameters

id string

The ID of the product. Example: molestiae

productId integer optional

Product Id. Example: 3

Body Parameters

name string

Dusty blue white flower comb Bride Bridesmaid floral hair piece Fall wedding hair accessories Example: dolores

title string

Dusty blue white flower comb Bride Bridesmaid floral hair piece Fall wedding hair accessories Example: qui

upc string

B073QK9LZX Example: aut

sku string

B072KG8H4M, BT-F10M-HAER Example: magni

productPacketType boolean true false

(0 | 1) Example: false

Proform Data

Display a listing of the proform data.

requires authentication

Example request:

$client = new \GuzzleHttp\Client();
$url = 'https://system.skladusa.com/api/proforma-data/category';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'Authorization' => 'required    Basic + base64 encoded \'user_id:api_token\'',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://system.skladusa.com/api/proforma-data/category"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": "required    Basic + base64 encoded &#039;user_id:api_token&#039;",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

curl --request GET \
    --get "https://system.skladusa.com/api/proforma-data/category" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: required    Basic + base64 encoded \&#039;user_id:api_token\&#039;"

Example response (200):


{
"data": {
"entities": [
{
"id": 1,
"nameEn": "Mechanical parts and tools",
"nameUa": "Механічні деталі та інструменти",
"nameRu": "Механические части и инструменты",
"names": [
         {
             "id": 328,
             "nameUa": "ІГРАШКА",
             "nameEn": "TOY",
             "nameRu": "ИГРУШКА"
         },
         ............
     ],
     "materials": [
         {
             "id": 329,
             "nameUa": "ФЕТР",
             "nameEn": "FELT",
             "nameRu": "фетр"
         },
         .........
     ],
     "for": [
         {
         "id": 4,
             "nameUa": "ЖІНОЧА",
             "nameEn": "WOMENS",
             "nameRu": "Женская"
         },
         .................
     ],
     "subMaterials": [
         {
         "id": 3,
             "nameUa": "ТКАНИЙ ",
             "nameEn": "WOVEN",
             "nameRu": "ТКАНИЙ "
         },
         ............
     ]
 },
  ......
 ],
"pagination": {
 "last": 1,
 "current": 0,
 "numItemsPerPage": 10,
 "first": 1,
 "pageCount": 1,
 "totalCount": 7,
 "pageRange": 1,
 "startPage": 1,
 "endPage": 1,
 "previous": 0,
 "next": 1,
 "pagesInRange": [
     1
  ],
 "firstPageInRange": 1,
 "lastPageInRange": 1,
 "currentItemCount": 10,
 "firstItemNumber": 11,
 "lastItemNumber": 1
 }
},
"status": "success"
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET /api/proforma-data/category

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Authorization

Example: required Basic + base64 encoded 'user_id:api_token'

URL Parameters

page integer optional

Current page default 1. Example: 17

numItemsPerPage integer optional

Num Items Per Page by default 20 max per page 100 Example: 5

Display the specified proform data resource.

requires authentication

Example request:

$client = new \GuzzleHttp\Client();
$url = 'https://system.skladusa.com/api/proforma-data/category/at';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'Authorization' => 'required   Basic + base64 encoded \'user_id:api_token\'',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://system.skladusa.com/api/proforma-data/category/at"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": "required   Basic + base64 encoded &#039;user_id:api_token&#039;",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

curl --request GET \
    --get "https://system.skladusa.com/api/proforma-data/category/at" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: required   Basic + base64 encoded \&#039;user_id:api_token\&#039;"

Example response (200):


{
"data": {
"entities": [
 {
 "id": 4,
 "nameEn": "Toys & Entertainment",
 "nameUa": "Іграшки та розваги",
 "nameRu": "Игрушки и развлечения",
 "names": [
    {
        "id": 328,
        "nameUa": "ІГРАШКА",
        "nameEn": "TOY",
        "nameRu": "ИГРУШКА"
    },
    ...........
 ],
 "materials": [
   {
       "id": 329,
       "nameUa": "ФЕТР",
       "nameEn": "FELT",
       "nameRu": "фетр"
   },
   .............
 ],
 "for": [
   {
   "id": 4,
       "nameUa": "ЖІНОЧА",
       "nameEn": "WOMENS",
       "nameRu": "Женская"
   },
 ],
 "subMaterials": [
  {
      "id": 330,
      "nameUa": "ТКАНИЙ ",
      "nameEn": "WOVEN",
      "nameRu": "ТКАНЫЙ"
  },
  ..........
 ]
 }
]
},
"status": "success"
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET /api/proforma-data/category/{id}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Authorization

Example: required Basic + base64 encoded 'user_id:api_token'

URL Parameters

id string

The ID of the category. Example: at

categoryId integer optional

Proform Category Data ID. Example: 13

Search Hs Code by proform options (name_id, material_id)

requires authentication

Example request:

$client = new \GuzzleHttp\Client();
$url = 'https://system.skladusa.com/api/proforma-data/hs-code';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'Authorization' => 'required   Basic + base64 encoded \'user_id:api_token\'',
        ],
        'json' => [
            'nameId' => 15,
            'materialId' => 17,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://system.skladusa.com/api/proforma-data/hs-code"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": "required   Basic + base64 encoded &#039;user_id:api_token&#039;",
};

let body = {
    "nameId": 15,
    "materialId": 17
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "https://system.skladusa.com/api/proforma-data/hs-code" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: required   Basic + base64 encoded \&#039;user_id:api_token\&#039;" \
    --data "{
    \"nameId\": 15,
    \"materialId\": 17
}"

Example response (200):


{
    "data": {
        "hsCode": "oo1430NSOVmFUieS"
    },
    "status": "success"
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST /api/proforma-data/hs-code

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Authorization

Example: required Basic + base64 encoded 'user_id:api_token'

Body Parameters

nameId integer optional

Proform Data name Id Example: 15

materialId integer optional

Proform Data material Id Example: 17

Key Crm

Prepare order data for Key Crm.

requires authentication

Example request:

$client = new \GuzzleHttp\Client();
$url = 'https://system.skladusa.com/api/key-crm/create-order';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'Authorization' => 'required    Basic + base64 encoded \'user_id:api_token\'',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://system.skladusa.com/api/key-crm/create-order"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": "required    Basic + base64 encoded &#039;user_id:api_token&#039;",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

curl --request GET \
    --get "https://system.skladusa.com/api/key-crm/create-order" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: required    Basic + base64 encoded \&#039;user_id:api_token\&#039;"

Example response (200):


{
    "status": "success",
    "request": {
        "receiverName": "John Smith",
        "receiverEmail": "[email protected]",
        "receiverPhone": "+380 971112233",
        "receiverAddress": "вулиця Перемоги",
        "receiverCity": "Житомир",
        "receiverZip": "10000",
        "receiverState": "Житомирська область",
        "receiverCountry": null,
        "weightLb": null,
        "weightOz": null,
        "length": null,
        "width": null,
        "height": null,
        "comment": null,
        "insurancesStatus": null,
        "insurances": null,
        "externalId": null,
        "apiShipMethod": null,
        "packagingId": null,
        "consolidationOrder": true,
        "skladCreateLabel": false,
        "userPackType": null,
        "productsData": null,
        "productsConsolidationData": [
            {
                "descrEn": "test listing",
                "count": 1
            }
        ],
        "transactionId": 24234
    },
    "order": {
        "id": 584,
        "receiverName": "John Smith",
        "createdAtStr": "2022-05-24 15:30:17",
        "receiverEmail": "[email protected]",
        "receiverAddress": "1630 91ST AVE NE STE 180",
        "receiverCity": "Blaine",
        "receiverZip": "55449",
        "receiverState": "MN",
        "receiverCountry": "United States",
        "receiverPhone": "101010",
        "comment": null,
        "weightLb": 0,
        "weightOz": 2,
        "length": null,
        "width": 2,
        "height": null,
        "consolidationOrder": false,
        "skladCreateLabel": false,
        "shipDate": {
            "date": "2022-05-24 13:38:40.000000",
            "timezone_type": 3,
            "timezone": "Europe/Kiev"
        },
        "shippingCosts": "3.37",
        "insurancesStatus": true,
        "insurances": "0.2",
        "externalId": null,
        "apiShipMethod": "1_1",
        "packagingId": 18,
        "userPackType": "pack1",
        "status": null,
        "vatTaxId": 641,
        "transactionId": 24234,
        "productsData": [
            {
                "productData": {
                    "count": 1,
                    "product": 1548
                }
            }
        ],
        "productsConsolidationData": []
    },
    "transactionInfo": {
        "gross": 2,
        "ppFee": 0.38,
        "skladUsaFee": 0.03,
        "sum": 1.59
    }
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET /api/key-crm/create-order

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Authorization

Example: required Basic + base64 encoded 'user_id:api_token'

URL Parameters

orderType string optional

set orderType one from list consolidation, self:create, sklad:create set consolidation if empty. Example: aspernatur

transaction string optional

transaction number. Example: ea

etsy string optional

etsy order id. Example: sit

Get Rate List for Key Crm

requires authentication

Example request:

$client = new \GuzzleHttp\Client();
$url = 'https://system.skladusa.com/api/key-crm/rate/list';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'Authorization' => 'required    Basic + base64 encoded \'user_id:api_token\'',
        ],
        'json' => [
            'senderCountryCode' => 'nihil',
            'length' => 'nam',
            'height' => 'ut',
            'width' => 'voluptas',
            'weight' => 'iste',
            'countryCode' => 'tempora',
            'stateCode' => 'laudantium',
            'zipCode' => 'ex',
            'city' => 'quaerat',
            'clientPayPal' => 'deserunt',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://system.skladusa.com/api/key-crm/rate/list"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": "required    Basic + base64 encoded &#039;user_id:api_token&#039;",
};

let body = {
    "senderCountryCode": "nihil",
    "length": "nam",
    "height": "ut",
    "width": "voluptas",
    "weight": "iste",
    "countryCode": "tempora",
    "stateCode": "laudantium",
    "zipCode": "ex",
    "city": "quaerat",
    "clientPayPal": "deserunt"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "https://system.skladusa.com/api/key-crm/rate/list" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: required    Basic + base64 encoded \&#039;user_id:api_token\&#039;" \
    --data "{
    \"senderCountryCode\": \"nihil\",
    \"length\": \"nam\",
    \"height\": \"ut\",
    \"width\": \"voluptas\",
    \"weight\": \"iste\",
    \"countryCode\": \"tempora\",
    \"stateCode\": \"laudantium\",
    \"zipCode\": \"ex\",
    \"city\": \"quaerat\",
    \"clientPayPal\": \"deserunt\"
}"

Example response (200):


{
    "status": "success",
    "data": {
        "case": {
            "fromCountry": "Ukraine",
            "fromCountryCode": "UA",
            "toCountry": "Germany",
            "toCountryCode": "DE",
            "stateCode": null,
            "zipCode": "10179",
            "city": "Berlin",
            "weight": "1",
            "length": "1",
            "width": "1",
            "height": "1",
            "clientPayPal": true
        },
        "shippingPrices": [
            {
                "type": "consolidation",
                "consolidation_type": "consolidation",
                "system_key": "DHLExpress",
                "currency": "USD",
                "description": "DHLExpress, ExpressWorldwideNonDoc Parcel",
                "costs": {
                    "price": "37.16",
                    "fee": 2
                },
                "apiShipMethod": "ExpressWorldwideNonDoc"
            },
            {
                "type": "consolidation",
                "consolidation_type": "consolidation",
                "system_key": "APC",
                "currency": "USD",
                "description": "Parcel Priority Delcon",
                "costs": {
                    "price": "26.39",
                    "fee": 2
                },
                "apiShipMethod": "parcelConnectPriorityDDUDelcon"
            },
            {
                "type": "consolidation",
                "consolidation_type": "consolidation",
                "system_key": "DPD",
                "currency": "USD",
                "description": "DPD",
                "costs": {
                    "price": "22.40",
                    "fee": 2
                },
                "apiShipMethod": "9_7"
            }
        ]
    }
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST /api/key-crm/rate/list

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Authorization

Example: required Basic + base64 encoded 'user_id:api_token'

Body Parameters

senderCountryCode required optional

string Sender country code. Example: nihil

length required optional

string Length,sm. Example: nam

height required optional

string Height,sm. Example: ut

width required optional

string Width,sm. Example: voluptas

weight required optional

string Weight,kg. Example: iste

countryCode required optional

string Country code. Example: tempora

stateCode string optional

Need when Country code - US. Example: laudantium

zipCode required optional

string Zip (postal) code. Example: ex

city required optional

string City. Example: quaerat

clientPayPal required optional

boolean PayPal client. Example: deserunt

Transactions

Display a listing of the user transactions.

requires authentication

Example request:

$client = new \GuzzleHttp\Client();
$url = 'https://system.skladusa.com/api/transactions';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'Authorization' => 'required    Basic + base64 encoded \'user_id:api_token\'',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://system.skladusa.com/api/transactions"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": "required    Basic + base64 encoded &#039;user_id:api_token&#039;",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

curl --request GET \
    --get "https://system.skladusa.com/api/transactions" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: required    Basic + base64 encoded \&#039;user_id:api_token\&#039;"

Example response (200):


{
"data": {
 "entities": [
 {
 "transaction": {
     "id": 125050,
     "orderId": null,
     "shopName": "UkiTreasures",
     "createdAt": "2021-05-04 15:21:22",
     "number": "7022037960438191Y",
     "payedUserName": "Meredith Zoul",
     "payedUserEmail": "[email protected]",
     "addressPart": "365 S Roys Ave",
     "totalSum": "85.99",
     "tax": "6.00",
     "interimSum": "77.71",
     "commission": "2.28",
     "deductionForUserBonus": 0,
     "deductionForSystem": "2.33",
     "sum": "75.38",
     "noteText": null,
     "country": "United States",
     "userPhone": "330-671-7480",
     "userState": "OH",
     "zip": "43204",
     "city": "Columbus",
     "paymentStatus": "Completed",
     "description": "Item #644068700 - SIMPSONS PORTRAIT on the couch, simpsons family portrait, Simpson couple portrait, cartoon portrait, simpsons couch, turn photo $79.99 (1 pc)"
   }
  }
 ],
 "pagination": {
     "last": 329,
     "current": 2,
     "numItemsPerPage": "1",
     "first": 1,
     "pageCount": 329,
     "totalCount": 329,
     "pageRange": 329,
     "startPage": 1,
     "endPage": 329,
     "previous": 1,
     "next": 3,
     "pagesInRange": [
         1,
         2,
         3,
         4,
     ],
     "firstPageInRange": 1,
     "lastPageInRange": 329,
     "currentItemCount": "1",
     "firstItemNumber": 2,
     "lastItemNumber": 2
  }
 },
 "status": "success"
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET /api/transactions

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Authorization

Example: required Basic + base64 encoded 'user_id:api_token'

URL Parameters

page integer optional

Current page default 1. Example: 2

numItemsPerPage integer optional

Num Items Per Page by default 20 max per page 100 Example: 8

Display the specified transaction.

requires authentication

Example request:

$client = new \GuzzleHttp\Client();
$url = 'https://system.skladusa.com/api/transactions/3';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'Authorization' => 'required    Basic + base64 encoded \'user_id:api_token\'',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://system.skladusa.com/api/transactions/3"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": "required    Basic + base64 encoded &#039;user_id:api_token&#039;",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

curl --request GET \
    --get "https://system.skladusa.com/api/transactions/3" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: required    Basic + base64 encoded \&#039;user_id:api_token\&#039;"

Example response (200):


{
    "data": {
        "transaction": {
            "id": 125050,
            "orderId": null,
            "shopName": "UkiTreasures",
            "createdAt": "2021-05-04 15:21:22",
            "number": "7004437960438191Y",
            "payedUserName": "Meredith Zoul",
            "payedUserEmail": "[email protected]",
            "addressPart": "365 S Roys Ave",
            "totalSum": "85.99",
            "tax": "6.00",
            "interimSum": "77.71",
            "commission": "2.28",
            "deductionForUserBonus": 0,
            "deductionForSystem": "2.33",
            "sum": "75.38",
            "itemNumber": {},
            "noteText": null,
            "country": "United States",
            "userPhone": "330-671-7480",
            "userState": "OH",
            "zip": "43204",
            "city": "Columbus",
            "paymentStatus": "Completed",
            "description": "Item #644068700 - SIMPSONS PORTRAIT on the couch, simpsons family portrait, Simpson couple portrait, cartoon portrait, simpsons couch, turn photo $79.99 (1 pc)"
        }
    },
    "status": "success"
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET /api/transactions/{id}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Authorization

Example: required Basic + base64 encoded 'user_id:api_token'

URL Parameters

id integer optional

Transaction Id. Example: 3

Send tracking number to payment system

requires authentication

Example request:

$client = new \GuzzleHttp\Client();
$url = 'https://system.skladusa.com/api/transactions/id/update-tracking-number';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'Authorization' => 'required    Basic + base64 encoded \'user_id:api_token\'',
        ],
        'json' => [
            'tracking-number' => 'necessitatibus',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://system.skladusa.com/api/transactions/id/update-tracking-number"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": "required    Basic + base64 encoded &#039;user_id:api_token&#039;",
};

let body = {
    "tracking-number": "necessitatibus"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "https://system.skladusa.com/api/transactions/id/update-tracking-number" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: required    Basic + base64 encoded \&#039;user_id:api_token\&#039;" \
    --data "{
    \"tracking-number\": \"necessitatibus\"
}"

Example response (200):


{
    "status": "ok",
    "message": "tracking-number send to transaction",
    "pay-system-status": "success",
    "pay-system-message": "send to pay system"
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST /api/transactions/{id}/update-tracking-number

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Authorization

Example: required Basic + base64 encoded 'user_id:api_token'

URL Parameters

id string

The ID of the transaction. Example: id

transactionId integer optional

required. Payment transaction id. Example: 19

Body Parameters

tracking-number required optional

string tracking number Example: necessitatibus

Prepare form for creating order from payment transaction

requires authentication

Example request:

$client = new \GuzzleHttp\Client();
$url = 'https://system.skladusa.com/api/transactions/eum/create-order';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'Authorization' => 'required    Basic + base64 encoded \'user_id:api_token\'',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://system.skladusa.com/api/transactions/eum/create-order"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": "required    Basic + base64 encoded &#039;user_id:api_token&#039;",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

curl --request GET \
    --get "https://system.skladusa.com/api/transactions/eum/create-order" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: required    Basic + base64 encoded \&#039;user_id:api_token\&#039;"

Example response (200):


{
    "status": "success",
    "request": {
        "receiverName": "Meredith Zoul",
        "receiverEmail": "[email protected]",
        "receiverPhone": "330-671-7480",
        "receiverAddress": "365 S Roys Ave",
        "receiverCity": "Columbus",
        "receiverZip": "43204",
        "receiverState": "OH",
        "receiverCountry": "United States",
        "weightLb": null,
        "weightOz": null,
        "length": null,
        "width": null,
        "height": null,
        "comment": null,
        "insurancesStatus": null,
        "insurances": null,
        "externalId": null,
        "apiShipMethod": null,
        "packagingId": null,
        "consolidationOrder": true,
        "skladCreateLabel": true,
        "userPackType": null,
        "transactionId": 125050,
        "productsData": null,
        "productsConsolidationData": null
    },
    "order": null
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET /api/transactions/{id}/create-order

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Authorization

Example: required Basic + base64 encoded 'user_id:api_token'

URL Parameters

id string

The ID of the transaction. Example: eum

transactionId integer optional

required. Payment transaction id. Example: 2

Orders FBM

Display a listing of the order fbm data.

requires authentication

Example request:

$client = new \GuzzleHttp\Client();
$url = 'https://system.skladusa.com/api/order';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'Authorization' => 'required    Basic + base64 encoded \'user_id:api_token\'',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://system.skladusa.com/api/order"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": "required    Basic + base64 encoded &#039;user_id:api_token&#039;",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

curl --request GET \
    --get "https://system.skladusa.com/api/order" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: required    Basic + base64 encoded \&#039;user_id:api_token\&#039;"

Example response (200):


{
"data": {
"entities": [
 "order": {
     "id": 143,
     "receiverName": "receiverName",
     "recipientCompanyName": "recipientCompanyName",
     "createdAtStr": "2022-05-05 13:58:38",
     "receiverEmail": "[email protected]",
     "receiverAddress": "receiver Address line 1",
     "receiverAddress1": "receiver Address line 2"
     "receiverCity": "receiverCity",
     "receiverZip": "receiverZip",
     "receiverState": "receiverState",
     "receiverCountry": "Ukraine",
     "receiverPhone": "0989701676",
     "comment": null,
     "weightLb": 11,
     "weightOz": 4,
     "length": 20,
     "width": 180,
     "height": 20,
     "consolidationOrder": false,
     "skladCreateLabel": true,
     "skladusaTrackingNumber": "SK11111111111UA",
     "shipDate": {
         "date": "2022-05-06 12:23:30.698958",
         "timezone_type": 3,
         "timezone": "Europe/Kiev"
     },
     "shippingCosts": null,
     "insurancesStatus": false,
     "insurances": null,
     "externalId": "1988820690",
     "apiShipMethod": "1_1",
     "packagingId": null,
     "userPackType": "pack1",
     "status": null,
     "vatTaxId": 81,
     "transactionId": null,
     "productsData": [],
     "storageId": 1,
     "productsConsolidationData": {
     "content": [
         {
             "forSelectedId": 4,
             "forSelectedEn": "WOMENS",
             "forSelectedUa": "ЖІНОЧА",
             "forSelectedRu": "Женская",
             "nameId": 328,
             "nameEn": "TOY",
             "nameUa": "ІГРАШКА",
             "nameRu": "ИГРУШКА",
             "materialId": 329,
             "materialEn": "FELT",
             "materialUa": "ФЕТР",
             "materialRu": "фетр",
             "subMaterialId": 330,
             "subMaterialEn": "WOVEN",
             "subMaterialUa": "ТКАНИЙ ",
             "subMaterialRu": "ТКАНЫЙ",
             "categoryId": 8,
             "categoryName": "Clothes & woven decor",
             "count": 1
         },
         {
             "forSelectedId": 4,
             "forSelectedEn": "WOMENS",
             "forSelectedUa": "ЖІНОЧА",
             "forSelectedRu": "Женская",
             "nameId": 331,
             "nameEn": "KNITTED WOVEN TOY",
             "nameUa": "ІГРАШКА В'ЯЗАНА ",
             "nameRu": "ИГРУШКА вязанная",
             "materialId": 332,
             "materialEn": "COTTON",
             "materialUa": "БАВОВНА",
             "materialRu": "Хлопок",
             "subMaterialId": 333,
             "subMaterialEn": "EMBROIDERED",
             "subMaterialUa": "ВИШИТИЙ",
             "subMaterialRu": "вышитый",
             "categoryId": 8,
             "categoryName": "Clothes & woven decor",
             "count": 2
         }
      ]
    },
  "sendFrom": {
         "first_name": "test firstnam112222e",
         "last_name": "test lastname11",
         "company_name": "test companynam11e",
         "full_name": "test firstnam112222e test lastname11",
         "label": "test firstnam112222e test lastname11 test companynam11e"
         },
  "sendFromId": "9"
     },
 }
 ............
 ]
}
],
"pagination": {
 "last": 2,
 "current": 0,
 "numItemsPerPage": 10,
 "first": 1,
 "pageCount": 2,
 "totalCount": 19,
 "pageRange": 2,
 "startPage": 1,
 "endPage": 2,
 "previous": 0,
 "next": 1,
 "pagesInRange": [
     1,
     2
 ],
 "firstPageInRange": 1,
 "lastPageInRange": 2,
 "currentItemCount": 10,
 "firstItemNumber": 11,
 "lastItemNumber": 2
 }
},
"status": "success"
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET /api/order

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Authorization

Example: required Basic + base64 encoded 'user_id:api_token'

URL Parameters

page integer optional

Current page default 1. Example: 11

numItemsPerPage integer optional

Num Items Per Page by default 20 max per page 100 Example: 8

Display example of the order fbm body response.

requires authentication

Example request:

$client = new \GuzzleHttp\Client();
$url = 'https://system.skladusa.com/api/order/example';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'Authorization' => 'required    Basic + base64 encoded \'user_id:api_token\'',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://system.skladusa.com/api/order/example"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": "required    Basic + base64 encoded &#039;user_id:api_token&#039;",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

curl --request GET \
    --get "https://system.skladusa.com/api/order/example" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: required    Basic + base64 encoded \&#039;user_id:api_token\&#039;"

Example response (200):


{
    "receiverName": "Carol Ann Dayton",
    "createdAtStr": "2018-10-08 07:30:46",
    "receiverEmail": "[email protected]",
    "receiverAddress": "Carol Ann Dayton, United States, NC, 28752, Marion, 36 Katydid Drive,",
    "receiverAddress1": "receiver Address line 2",
    "receiverCity": "Marion",
    "receiverZip": "28752",
    "receiverState": "Marion",
    "receiverCountry": "US",
    "receiverPhone": "Marion",
    "comment": "",
    "weightLb": "",
    "weightOz": "",
    "length": "",
    "width": "",
    "height": "",
    "consolidationOrder": 1,
    "skladCreateLabel": 0,
    "productsConsolidationData": [
        {
            "descrEn": "Product One",
            "count": "2"
        },
        {
            "descrEn": "Product Two",
            "count": "3"
        }
    ]
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Display a listing of the shipping methods.

requires authentication

Example request:

$client = new \GuzzleHttp\Client();
$url = 'https://system.skladusa.com/api/shipping-method';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'Authorization' => 'required    Basic + base64 encoded \'user_id:api_token\'',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://system.skladusa.com/api/shipping-method"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": "required    Basic + base64 encoded &#039;user_id:api_token&#039;",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

curl --request GET \
    --get "https://system.skladusa.com/api/shipping-method" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: required    Basic + base64 encoded \&#039;user_id:api_token\&#039;"

Example response (200):


{
    "data": {
        "entities": [
            {
                "name": "USPS",
                "id": "1_1",
                "forUSA": "Yes",
                "forNonUSA": "No"
            },
            {
                "name": "USPS International (14-21 days)",
                "id": "2_2",
                "forUSA": "No",
                "forNonUSA": "Yes"
            },
            {
                "name": "FedEx Ground",
                "id": "3_3",
                "forUSA": "Yes",
                "forNonUSA": "No"
            },
            {
                "name": "FedEx Overnight",
                "id": "4_3",
                "forUSA": "Yes",
                "forNonUSA": "No"
            },
            {
                "name": "FedEx 2-Day Air",
                "id": "5_3",
                "forUSA": "Yes",
                "forNonUSA": "No"
            },
            {
                "name": "FedEx Ground Economy",
                "id": "6_3",
                "forUSA": "Yes",
                "forNonUSA": "No"
            },
            {
                "name": "DHL Worldwide",
                "id": "7_5",
                "forUSA": "No",
                "forNonUSA": "Yes"
            },
            {
                "name": "Parcel Priority Delcon(10-15 days)",
                "id": "8_6",
                "forUSA": "No",
                "forNonUSA": "Yes"
            },
            {
                "name": "DPD.cz",
                "id": "9_7",
                "forUSA": "No",
                "forNonUSA": "Yes"
            }
        ]
    },
    "status": "success"
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Display the delivery methods for order fbm resource.

requires authentication

Example request:

$client = new \GuzzleHttp\Client();
$url = 'https://system.skladusa.com/api/order/sunt/get-delivery-methods';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'Authorization' => 'required   Basic + base64 encoded \'user_id:api_token\'',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://system.skladusa.com/api/order/sunt/get-delivery-methods"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": "required   Basic + base64 encoded &#039;user_id:api_token&#039;",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

curl --request GET \
    --get "https://system.skladusa.com/api/order/sunt/get-delivery-methods" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: required   Basic + base64 encoded \&#039;user_id:api_token\&#039;"

Example response (200):


{
    "status": "success",
    "data": [
        {
            "serviceName": "USPS, Priority Mail",
            "serviceId": "USPS:Priority:Parcel",
            "shippingCosts": "9.01"
        }
    ]
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET /api/order/{id}/get-delivery-methods

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Authorization

Example: required Basic + base64 encoded 'user_id:api_token'

URL Parameters

id string

The ID of the order. Example: sunt

orderFbmId integer optional

Order Id. Example: 20

Display a listing of the packing types.

requires authentication

Example request:

$client = new \GuzzleHttp\Client();
$url = 'https://system.skladusa.com/api/user-pack-type';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'Authorization' => 'required    Basic + base64 encoded \'user_id:api_token\'',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://system.skladusa.com/api/user-pack-type"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": "required    Basic + base64 encoded &#039;user_id:api_token&#039;",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

curl --request GET \
    --get "https://system.skladusa.com/api/user-pack-type" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: required    Basic + base64 encoded \&#039;user_id:api_token\&#039;"

Example response (200):


{
    "data": [
        {
            "id": "pack1",
            "name": "Определяет склад"
        },
        {
            "id": "pack2",
            "name": "Пакет"
        },
        {
            "id": "pack3",
            "name": "Пузырчатый пакет"
        },
        {
            "id": "pack4",
            "name": "Коробка"
        },
        {
            "id": "pack5",
            "name": "Подарочный пакет"
        }
    ],
    "status": "success"
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Get packing type price list for order.

requires authentication

Example request:

$client = new \GuzzleHttp\Client();
$url = 'https://system.skladusa.com/api/packaging-type';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'Authorization' => 'required    Basic + base64 encoded \'user_id:api_token\'',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://system.skladusa.com/api/packaging-type"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": "required    Basic + base64 encoded &#039;user_id:api_token&#039;",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

curl --request GET \
    --get "https://system.skladusa.com/api/packaging-type" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: required    Basic + base64 encoded \&#039;user_id:api_token\&#039;"

Example response (200):


{
    "data": {
        "entities": [
            {
                "id": 7,
                "name": "$0 [Don't need extra packaging]"
            },
            {
                "id": 1,
                "name": "$0.05 [Small Poly 15x21]"
            },
            {
                "id": 2,
                "name": "$0.1 [Medium Poly 24x32]"
            },
            {
                "id": 3,
                "name": "$0.2 [Large Poly 30x40 - Medium Bubbles 23x18]"
            },
            {
                "id": 4,
                "name": "$0.5 [MD Bubble - XL Poly - Small Box  16x16x11 - 3.5 oz]"
            },
            {
                "id": 6,
                "name": "$0.5 [Large Bubbles 40x30 1oz - Medium Box 20x20x10 4 oz]"
            },
            {
                "id": 10,
                "name": "$0.75 [Box 25 x 20 x 8 - 3oz]"
            },
            {
                "id": 11,
                "name": "$1 [Tubus 79x5 - 6oz/Tubus 79x5 - 6oz/Large Box 23x23x10 - 7oz]"
            },
            {
                "id": 15,
                "name": "$1.5 [X-Large Box 38x25x13 - 9oz]"
            },
            {
                "id": 12,
                "name": "$2 [Long Box - 70x14x14 11oz]"
            },
            {
                "id": 13,
                "name": "$2 [Gift Bag 15x40x30 - $2.00]"
            }
        ]
    },
    "status": "success"
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Display the specified order fbm resource.

requires authentication

Example request:

$client = new \GuzzleHttp\Client();
$url = 'https://system.skladusa.com/api/order/iste';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'Authorization' => 'required   Basic + base64 encoded \'user_id:api_token\'',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://system.skladusa.com/api/order/iste"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": "required   Basic + base64 encoded &#039;user_id:api_token&#039;",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

curl --request GET \
    --get "https://system.skladusa.com/api/order/iste" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: required   Basic + base64 encoded \&#039;user_id:api_token\&#039;"

Example response (200):


{
"data": [
 {
 "order": {
     "id": 143,
     "receiverName": "receiverName",
     "recipientCompanyName": "recipientCompanyName",
     "createdAtStr": "2022-05-05 13:58:38",
     "receiverEmail": "[email protected]",
     "receiverAddress": "receiverAddress",
     "receiverAddress1": "receiver Address line 2",
     "receiverCity": "receiverCity",
     "receiverZip": "receiverZip",
     "receiverState": "receiverState",
     "receiverCountry": "Ukraine",
     "receiverPhone": "0989701676",
     "comment": null,
     "weightLb": 11,
     "weightOz": 4,
     "length": 20,
     "width": 180,
     "height": 20,
     "consolidationOrder": false,
     "skladCreateLabel": true,
     "skladusaTrackingNumber": "SK11111111111UA",
     "shipDate": {
         "date": "2022-05-06 12:23:30.698958",
         "timezone_type": 3,
         "timezone": "Europe/Kiev"
     },
     "shippingCosts": null,
     "insurancesStatus": false,
     "insurances": null,
     "externalId": "1988820690",
     "apiShipMethod": "1_1",
     "packagingId": null,
     "userPackType": "pack1",
     "status": null,
     "vatTaxId": 81,
     "transactionId": null,
     "storageId": 1,
     "productsData": [],
     "productsConsolidationData": {
     "content": [
         {
             "forSelectedId": 4,
             "forSelectedEn": "WOMENS",
             "forSelectedUa": "ЖІНОЧА",
             "forSelectedRu": "Женская",
             "nameId": 328,
             "nameEn": "TOY",
             "nameUa": "ІГРАШКА",
             "nameRu": "ИГРУШКА",
             "materialId": 329,
             "materialEn": "FELT",
             "materialUa": "ФЕТР",
             "materialRu": "фетр",
             "subMaterialId": 330,
             "subMaterialEn": "WOVEN",
             "subMaterialUa": "ТКАНИЙ ",
             "subMaterialRu": "ТКАНЫЙ",
             "categoryId": 8,
             "categoryName": "Clothes & woven decor",
             "count": 1
         },
         {
             "forSelectedId": 4,
             "forSelectedEn": "WOMENS",
             "forSelectedUa": "ЖІНОЧА",
             "forSelectedRu": "Женская",
             "nameId": 331,
             "nameEn": "KNITTED WOVEN TOY",
             "nameUa": "ІГРАШКА В'ЯЗАНА ",
             "nameRu": "ИГРУШКА вязанная",
             "materialId": 332,
             "materialEn": "COTTON",
             "materialUa": "БАВОВНА",
             "materialRu": "Хлопок",
             "subMaterialId": 333,
             "subMaterialEn": "EMBROIDERED",
             "subMaterialUa": "ВИШИТИЙ",
             "subMaterialRu": "вышитый",
             "categoryId": 8,
             "categoryName": "Clothes & woven decor",
             "count": 2
         }
      ]
    }
 }
 "status": "success"
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET /api/order/{id}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Authorization

Example: required Basic + base64 encoded 'user_id:api_token'

URL Parameters

id string

The ID of the order. Example: iste

orderFbmId integer optional

Order Id. Example: 20

Get tracking history by order id.

requires authentication

Example request:

$client = new \GuzzleHttp\Client();
$url = 'https://system.skladusa.com/api/order/consequatur/track';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'Authorization' => 'required    Basic + base64 encoded \'user_id:api_token\'',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://system.skladusa.com/api/order/consequatur/track"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": "required    Basic + base64 encoded &#039;user_id:api_token&#039;",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

curl --request GET \
    --get "https://system.skladusa.com/api/order/consequatur/track" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: required    Basic + base64 encoded \&#039;user_id:api_token\&#039;"

Example response (200):


{
    "data": {
        "message": "Delivered",
        "history": [
            "Shipping Label Created, USPS Awaiting Item 2021-12-10 14:38:00",
            "Accepted at USPS Origin Facility 2021-12-22 20:25:00",
            "Arrived at USPS Origin Facility 2021-12-22 21:40:00",
            "Departed USPS Origin Facility 2021-12-22 21:52:00",
            "Arrived at USPS Regional Origin Facility 2021-12-24 22:07:00",
            "In Transit to Next Facility 2021-12-28 00:00:00",
            "Arrived at USPS Regional Destination Facility 2021-12-29 15:27:00",
            "Departed USPS Regional Facility 2021-12-30 03:07:00",
            "Arrived at USPS Facility 2021-12-30 04:03:00",
            "Arrived at Post Office 2021-12-30 04:36:00",
            "Out for Delivery 2021-12-30 06:10:00",
            "Delivered, In/At Mailbox 2021-12-30 13:58:00"
        ],
        "trackingNumber": "9400136109361359102933"
    },
    "status": "success"
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET /api/order/{id}/track

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Authorization

Example: required Basic + base64 encoded 'user_id:api_token'

URL Parameters

id string

The ID of the order. Example: consequatur

orderFbmId integer optional

Order Id. Example: 19

Store the specified order fbm resource.

requires authentication

Example request:

$client = new \GuzzleHttp\Client();
$url = 'https://system.skladusa.com/api/order';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'Authorization' => 'required    Basic + base64 encoded \'user_id:api_token\'',
        ],
        'json' => [
            'receiverName' => 'dicta',
            'recipientCompanyName' => 'quae',
            'receiverEmail' => '[email protected]',
            'receiverPhone' => 'harum',
            'receiverAddress' => 'eveniet',
            'receiverAddress1' => 'praesentium',
            'receiverCity' => 'porro',
            'receiverZip' => 'sed',
            'receiverState' => 'consequuntur',
            'receiverCountry' => 'rem',
            'storageId' => 13,
            'weightLb' => 'ut',
            'weightOz' => 'sit',
            'length' => 'culpa',
            'width' => 'suscipit',
            'height' => 'aperiam',
            'comment' => 'temporibus',
            'vatTaxId' => 'voluptatem',
            'insurancesStatus' => false,
            'insurances' => 'libero',
            'transactionId' => 11.98417124,
            'externalId' => 'sint',
            'apiShipMethod' => 'perferendis',
            'packagingId' => 'et',
            'consolidationOrder' => 'ut',
            'skladCreateLabel' => 'quas',
            'userPackType' => 'aut',
            'productsConsolidationData' => 'distinctio',
            'sendFromId' => 'iusto',
            'productsData' => [
                [
                    'product' => '2321',
                    'hsCode' => '324325SDA.001',
                    'price' => '3.09',
                    'description' => 'Product description text for int.',
                    'count' => '2',
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://system.skladusa.com/api/order"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": "required    Basic + base64 encoded &#039;user_id:api_token&#039;",
};

let body = {
    "receiverName": "dicta",
    "recipientCompanyName": "quae",
    "receiverEmail": "[email protected]",
    "receiverPhone": "harum",
    "receiverAddress": "eveniet",
    "receiverAddress1": "praesentium",
    "receiverCity": "porro",
    "receiverZip": "sed",
    "receiverState": "consequuntur",
    "receiverCountry": "rem",
    "storageId": 13,
    "weightLb": "ut",
    "weightOz": "sit",
    "length": "culpa",
    "width": "suscipit",
    "height": "aperiam",
    "comment": "temporibus",
    "vatTaxId": "voluptatem",
    "insurancesStatus": false,
    "insurances": "libero",
    "transactionId": 11.98417124,
    "externalId": "sint",
    "apiShipMethod": "perferendis",
    "packagingId": "et",
    "consolidationOrder": "ut",
    "skladCreateLabel": "quas",
    "userPackType": "aut",
    "productsConsolidationData": "distinctio",
    "sendFromId": "iusto",
    "productsData": [
        {
            "product": "2321",
            "hsCode": "324325SDA.001",
            "price": "3.09",
            "description": "Product description text for int.",
            "count": "2"
        }
    ]
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request PUT \
    "https://system.skladusa.com/api/order" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: required    Basic + base64 encoded \&#039;user_id:api_token\&#039;" \
    --data "{
    \"receiverName\": \"dicta\",
    \"recipientCompanyName\": \"quae\",
    \"receiverEmail\": \"[email protected]\",
    \"receiverPhone\": \"harum\",
    \"receiverAddress\": \"eveniet\",
    \"receiverAddress1\": \"praesentium\",
    \"receiverCity\": \"porro\",
    \"receiverZip\": \"sed\",
    \"receiverState\": \"consequuntur\",
    \"receiverCountry\": \"rem\",
    \"storageId\": 13,
    \"weightLb\": \"ut\",
    \"weightOz\": \"sit\",
    \"length\": \"culpa\",
    \"width\": \"suscipit\",
    \"height\": \"aperiam\",
    \"comment\": \"temporibus\",
    \"vatTaxId\": \"voluptatem\",
    \"insurancesStatus\": false,
    \"insurances\": \"libero\",
    \"transactionId\": 11.98417124,
    \"externalId\": \"sint\",
    \"apiShipMethod\": \"perferendis\",
    \"packagingId\": \"et\",
    \"consolidationOrder\": \"ut\",
    \"skladCreateLabel\": \"quas\",
    \"userPackType\": \"aut\",
    \"productsConsolidationData\": \"distinctio\",
    \"sendFromId\": \"iusto\",
    \"productsData\": [
        {
            \"product\": \"2321\",
            \"hsCode\": \"324325SDA.001\",
            \"price\": \"3.09\",
            \"description\": \"Product description text for int.\",
            \"count\": \"2\"
        }
    ]
}"

Example response (200):


{
"data": [
 {
 "order": {
     "id": 143,
     "receiverName": "receiverName",
     "recipientCompanyName": "recipientCompanyName",
     "createdAtStr": "2022-05-05 13:58:38",
     "receiverEmail": "[email protected]",
     "receiverAddress": "receiverAddress",
     "receiverCity": "receiverCity",
     "receiverZip": "receiverZip",
     "receiverState": "receiverState",
     "receiverCountry": "Ukraine",
     "receiverPhone": "0989701676",
     "comment": null,
     "weightLb": 11,
     "weightOz": 4,
     "length": 20,
     "width": 180,
     "height": 20,
     "consolidationOrder": false,
     "skladCreateLabel": true,
     "skladusaTrackingNumber": "SK11111111111UA",
     "shipDate": {
         "date": "2022-05-06 12:23:30.698958",
         "timezone_type": 3,
         "timezone": "Europe/Kiev"
     },
     "shippingCosts": null,
     "insurancesStatus": false,
     "insurances": null,
     "externalId": "1988820690",
     "storageId" : 1,
     "apiShipMethod": "1_1",
     "packagingId": null,
     "userPackType": "pack1",
     "status": null,
     "vatTaxId": 81,
     "transactionId": null,
     "productsData": [],
     "productsConsolidationData": {
     "content": [
         {
             "forSelectedId": 4,
             "forSelectedEn": "WOMENS",
             "forSelectedUa": "ЖІНОЧА",
             "forSelectedRu": "Женская",
             "nameId": 328,
             "nameEn": "TOY",
             "nameUa": "ІГРАШКА",
             "nameRu": "ИГРУШКА",
             "materialId": 329,
             "materialEn": "FELT",
             "materialUa": "ФЕТР",
             "materialRu": "фетр",
             "subMaterialId": 330,
             "subMaterialEn": "WOVEN",
             "subMaterialUa": "ТКАНИЙ ",
             "subMaterialRu": "ТКАНЫЙ",
             "categoryId": 8,
             "categoryName": "Clothes & woven decor",
             "count": 1
         },
         {
             "forSelectedId": 4,
             "forSelectedEn": "WOMENS",
             "forSelectedUa": "ЖІНОЧА",
             "forSelectedRu": "Женская",
             "nameId": 331,
             "nameEn": "KNITTED WOVEN TOY",
             "nameUa": "ІГРАШКА В'ЯЗАНА ",
             "nameRu": "ИГРУШКА вязанная",
             "materialId": 332,
             "materialEn": "COTTON",
             "materialUa": "БАВОВНА",
             "materialRu": "Хлопок",
             "subMaterialId": 333,
             "subMaterialEn": "EMBROIDERED",
             "subMaterialUa": "ВИШИТИЙ",
             "subMaterialRu": "вышитый",
             "categoryId": 8,
             "categoryName": "Clothes & woven decor",
             "count": 2
         }
      ]
    }
 "sendFrom": {
         "first_name": "test firstnam112222e",
         "last_name": "test lastname11",
         "company_name": "test companynam11e",
         "full_name": "test firstnam112222e test lastname11",
         "label": "test firstnam112222e test lastname11 test companynam11e"
         },
  "sendFromId": "9"
     },
     "status": "success"
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PUT /api/order

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Authorization

Example: required Basic + base64 encoded 'user_id:api_token'

Body Parameters

receiverName required optional

string Receiver name Example: dicta

recipientCompanyName required optional

string Receiver company name Example: quae

receiverEmail required optional

string Receiver email Example: [email protected]

receiverPhone string optional

Receiver phone Example: harum

receiverAddress required optional

string Receiver address line 1 Example: eveniet

receiverAddress1 string optional

Receiver address line 2 Example: praesentium

receiverCity required optional

string Receiver city Example: porro

receiverZip required optional

string Receiver zip number Example: sed

receiverState required optional

string Receiver state Example: consequuntur

receiverCountry required optional

string Receiver country (Code iso 2) Example: rem

storageId integer optional

storage Id can get in route "https://system.skladusa.com/api/storage/order-fbm" Example: 13

weightLb numeric optional

Weight in pound Example: ut

weightOz numeric optional

Weight in ounce Example: sit

length numeric optional

Length in sm Example: culpa

width numeric optional

Width in sm Example: suscipit

height numeric optional

Height in sm Example: aperiam

comment string optional

Comment Example: temporibus

vatTaxId string optional

VATTAXID Example: voluptatem

insurancesStatus boolean optional true false

Insurance? 0=No; 1=Yes Example: false

insurances numeric optional

Insurance Amount Example: libero

transactionId number optional

Example: 11.98417124

externalId string optional

External Id max lenth 256 Example: sint

apiShipMethod string optional

Ship Method (999_999) Example: perferendis

packagingId string optional

External packaging Id Example: et

consolidationOrder required optional

bool Consolidation order ? 0=No; 1=Yes Example: ut

skladCreateLabel required optional

bool Sklad Create Label for order ? 0=No; 1=Yes Example: quas

userPackType string optional

pack1 - Warehouse discretion, pack2 - Package, pack3 - Bubbles pack, pack4 - Carton Example: aut

productsConsolidationData required optional

array Array or object productConsolidationType Example: distinctio

id integer optional

Element id or null if new Example: 13

categoryId required optional

integer Category Id Example: doloribus

descrEn string optional

Example: iusto

nameId required optional

integer Name Id Example: ea

forSelectedId integer optional

For Selected Id Example: 12

materialId integer optional

Material Id Example: 2

subMaterialId integer optional

SubMaterialId Id Example: 1

hsCode string optional

HsCode Example: aut

price required optional

numeric Product Price Example: excepturi

count required optional

integer Product quantity Example: nemo

productsData object[] optional

This field is required when consolidationOrder is 0.

product required optional

integer Product product_id Example: 2321

hsCode optional optional

string Product hs_code Example: 324325SDA.001

price numeric optional

Product item_price Example: 3.09

description required optional

integer Product item_description Example: Product description text for int.

count required optional

numeric Product quantity Example: 2

sendFromId int|null optional

Selected send from address id (може бути не вказано, у такому разі буде використаний перший з створених користувачем) Example: iusto

Get Rate List for Order FBM

requires authentication

Example request:

$client = new \GuzzleHttp\Client();
$url = 'https://system.skladusa.com/api/rate/list';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'Authorization' => 'required    Basic + base64 encoded \'user_id:api_token\'',
        ],
        'json' => [
            'senderCountryCode' => 'quia',
            'length' => 'dolor',
            'height' => 'nemo',
            'width' => 'ratione',
            'weight' => 'fugiat',
            'countryCode' => 'est',
            'stateCode' => 'consequatur',
            'zipCode' => 'nemo',
            'city' => 'in',
            'clientPayPal' => 'fuga',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://system.skladusa.com/api/rate/list"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": "required    Basic + base64 encoded &#039;user_id:api_token&#039;",
};

let body = {
    "senderCountryCode": "quia",
    "length": "dolor",
    "height": "nemo",
    "width": "ratione",
    "weight": "fugiat",
    "countryCode": "est",
    "stateCode": "consequatur",
    "zipCode": "nemo",
    "city": "in",
    "clientPayPal": "fuga"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "https://system.skladusa.com/api/rate/list" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: required    Basic + base64 encoded \&#039;user_id:api_token\&#039;" \
    --data "{
    \"senderCountryCode\": \"quia\",
    \"length\": \"dolor\",
    \"height\": \"nemo\",
    \"width\": \"ratione\",
    \"weight\": \"fugiat\",
    \"countryCode\": \"est\",
    \"stateCode\": \"consequatur\",
    \"zipCode\": \"nemo\",
    \"city\": \"in\",
    \"clientPayPal\": \"fuga\"
}"

Example response (200):


{
    "status": "success",
    "data": {
        "case": {
            "fromCountry": "Ukraine",
            "fromCountryCode": "UA",
            "toCountry": "Germany",
            "toCountryCode": "DE",
            "stateCode": null,
            "zipCode": "10179",
            "city": "Berlin",
            "weight": "1",
            "length": "1",
            "width": "1",
            "height": "1",
            "clientPayPal": true
        },
        "shippingPrices": {
            "currency": "USD",
            "express": [],
            "consolidation": [
                {
                    "description": "DHLExpress, ExpressWorldwideNonDoc Parcel",
                    "costs": {
                        "price": "37.16",
                        "fee": 2
                    },
                    "apiShipMethod": "ExpressWorldwideNonDoc"
                },
                {
                    "description": "Parcel Priority Delcon",
                    "costs": {
                        "price": "26.39",
                        "fee": 2
                    },
                    "apiShipMethod": "parcelConnectPriorityDDUDelcon"
                },
                {
                    "description": "DPD",
                    "costs": {
                        "price": "22.40",
                        "fee": 2
                    },
                    "apiShipMethod": "9_7"
                }
            ]
        }
    }
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST /api/rate/list

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Authorization

Example: required Basic + base64 encoded 'user_id:api_token'

Body Parameters

senderCountryCode required optional

string Sender country code. Example: quia

length required optional

string Length,sm. Example: dolor

height required optional

string Height,sm. Example: nemo

width required optional

string Width,sm. Example: ratione

weight required optional

string Weight,kg. Example: fugiat

countryCode required optional

string Country code. Example: est

stateCode string optional

Need when Country code - US. Example: consequatur

zipCode required optional

string Zip (postal) code. Example: nemo

city required optional

string City. Example: in

clientPayPal required optional

boolean PayPal client. Example: fuga

Update the specified order fbm resource.

requires authentication

Example request:

$client = new \GuzzleHttp\Client();
$url = 'https://system.skladusa.com/api/order/voluptates';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'Authorization' => 'required    Basic + base64 encoded \'user_id:api_token\'',
        ],
        'json' => [
            'receiverName' => 'earum',
            'recipientCompanyName' => 'quod',
            'receiverEmail' => '[email protected]',
            'receiverPhone' => 'ut',
            'receiverAddress' => 'eveniet',
            'receiverAddress1' => 'quis',
            'receiverCity' => 'suscipit',
            'receiverZip' => 'beatae',
            'receiverState' => 'tempora',
            'receiverCountry' => 'enim',
            'storageId' => 13,
            'weightLb' => 'iste',
            'weightOz' => 'magni',
            'length' => 'occaecati',
            'width' => 'dignissimos',
            'height' => 'ducimus',
            'comment' => 'et',
            'vatTaxId' => 'porro',
            'insurancesStatus' => true,
            'insurances' => 'enim',
            'transactionId' => 3795.5562501,
            'externalId' => 'error',
            'apiShipMethod' => 'possimus',
            'packagingId' => 'ipsa',
            'consolidationOrder' => 'commodi',
            'skladCreateLabel' => 'vero',
            'userPackType' => 'non',
            'productsConsolidationData' => 'excepturi',
            'sendFromId' => 'accusamus',
            'productsData' => [
                [
                    'product' => 1,
                    'hsCode' => 2.222942,
                    'price' => 60.3164,
                    'description' => 'Consequatur reprehenderit ducimus error qui perferendis.',
                    'count' => 79,
                ],
            ],
            'productsConsolidationData[][id]' => 9,
            'productsConsolidationData[][categoryId]' => 'veritatis',
            'productsConsolidationData[][nameId]' => 'dolore',
            'productsConsolidationData[][forSelectedId]' => 17,
            'productsConsolidationData[][materialId]' => 12,
            'productsConsolidationData[][subMaterialId]' => 9,
            'productsConsolidationData[][hsCode]' => 'blanditiis',
            'productsConsolidationData[][price]' => 'tempore',
            'productsConsolidationData[][count]' => 'et',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://system.skladusa.com/api/order/voluptates"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": "required    Basic + base64 encoded &#039;user_id:api_token&#039;",
};

let body = {
    "receiverName": "earum",
    "recipientCompanyName": "quod",
    "receiverEmail": "[email protected]",
    "receiverPhone": "ut",
    "receiverAddress": "eveniet",
    "receiverAddress1": "quis",
    "receiverCity": "suscipit",
    "receiverZip": "beatae",
    "receiverState": "tempora",
    "receiverCountry": "enim",
    "storageId": 13,
    "weightLb": "iste",
    "weightOz": "magni",
    "length": "occaecati",
    "width": "dignissimos",
    "height": "ducimus",
    "comment": "et",
    "vatTaxId": "porro",
    "insurancesStatus": true,
    "insurances": "enim",
    "transactionId": 3795.5562501,
    "externalId": "error",
    "apiShipMethod": "possimus",
    "packagingId": "ipsa",
    "consolidationOrder": "commodi",
    "skladCreateLabel": "vero",
    "userPackType": "non",
    "productsConsolidationData": "excepturi",
    "sendFromId": "accusamus",
    "productsData": [
        {
            "product": 1,
            "hsCode": 2.222942,
            "price": 60.3164,
            "description": "Consequatur reprehenderit ducimus error qui perferendis.",
            "count": 79
        }
    ],
    "productsConsolidationData[][id]": 9,
    "productsConsolidationData[][categoryId]": "veritatis",
    "productsConsolidationData[][nameId]": "dolore",
    "productsConsolidationData[][forSelectedId]": 17,
    "productsConsolidationData[][materialId]": 12,
    "productsConsolidationData[][subMaterialId]": 9,
    "productsConsolidationData[][hsCode]": "blanditiis",
    "productsConsolidationData[][price]": "tempore",
    "productsConsolidationData[][count]": "et"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "https://system.skladusa.com/api/order/voluptates" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: required    Basic + base64 encoded \&#039;user_id:api_token\&#039;" \
    --data "{
    \"receiverName\": \"earum\",
    \"recipientCompanyName\": \"quod\",
    \"receiverEmail\": \"[email protected]\",
    \"receiverPhone\": \"ut\",
    \"receiverAddress\": \"eveniet\",
    \"receiverAddress1\": \"quis\",
    \"receiverCity\": \"suscipit\",
    \"receiverZip\": \"beatae\",
    \"receiverState\": \"tempora\",
    \"receiverCountry\": \"enim\",
    \"storageId\": 13,
    \"weightLb\": \"iste\",
    \"weightOz\": \"magni\",
    \"length\": \"occaecati\",
    \"width\": \"dignissimos\",
    \"height\": \"ducimus\",
    \"comment\": \"et\",
    \"vatTaxId\": \"porro\",
    \"insurancesStatus\": true,
    \"insurances\": \"enim\",
    \"transactionId\": 3795.5562501,
    \"externalId\": \"error\",
    \"apiShipMethod\": \"possimus\",
    \"packagingId\": \"ipsa\",
    \"consolidationOrder\": \"commodi\",
    \"skladCreateLabel\": \"vero\",
    \"userPackType\": \"non\",
    \"productsConsolidationData\": \"excepturi\",
    \"sendFromId\": \"accusamus\",
    \"productsData\": [
        {
            \"product\": 1,
            \"hsCode\": 2.222942,
            \"price\": 60.3164,
            \"description\": \"Consequatur reprehenderit ducimus error qui perferendis.\",
            \"count\": 79
        }
    ],
    \"productsConsolidationData[][id]\": 9,
    \"productsConsolidationData[][categoryId]\": \"veritatis\",
    \"productsConsolidationData[][nameId]\": \"dolore\",
    \"productsConsolidationData[][forSelectedId]\": 17,
    \"productsConsolidationData[][materialId]\": 12,
    \"productsConsolidationData[][subMaterialId]\": 9,
    \"productsConsolidationData[][hsCode]\": \"blanditiis\",
    \"productsConsolidationData[][price]\": \"tempore\",
    \"productsConsolidationData[][count]\": \"et\"
}"

Example response (200):


{
"data": [
 {
 "order": {
     "id": 143,
     "receiverName": "receiverName",
     "recipientCompanyName": "recipientCompanyName",
     "createdAtStr": "2022-05-05 13:58:38",
     "receiverEmail": "[email protected]",
     "receiverAddress": "receiverAddress",
     "receiverCity": "receiverCity",
     "receiverZip": "receiverZip",
     "receiverState": "receiverState",
     "receiverCountry": "Ukraine",
     "receiverPhone": "0989701676",
     "comment": null,
     "weightLb": 11,
     "weightOz": 4,
     "length": 20,
     "width": 180,
     "height": 20,
     "consolidationOrder": false,
     "skladCreateLabel": true,
     "skladusaTrackingNumber": "SK11111111111UA",
     "shipDate": {
         "date": "2022-05-06 12:23:30.698958",
         "timezone_type": 3,
         "timezone": "Europe/Kiev"
     },
     "shippingCosts": null,
     "insurancesStatus": false,
     "insurances": null,
     "externalId": "1988820690",
     "storageId" : 1,
     "apiShipMethod": "1_1",
     "packagingId": null,
     "userPackType": "pack1",
     "status": null,
     "vatTaxId": 81,
     "transactionId": null,
     "productsData": [],
     "productsConsolidationData": {
     "content": [
         {
             "forSelectedId": 4,
             "forSelectedEn": "WOMENS",
             "forSelectedUa": "ЖІНОЧА",
             "forSelectedRu": "Женская",
             "nameId": 328,
             "nameEn": "TOY",
             "nameUa": "ІГРАШКА",
             "nameRu": "ИГРУШКА",
             "materialId": 329,
             "materialEn": "FELT",
             "materialUa": "ФЕТР",
             "materialRu": "фетр",
             "subMaterialId": 330,
             "subMaterialEn": "WOVEN",
             "subMaterialUa": "ТКАНИЙ ",
             "subMaterialRu": "ТКАНЫЙ",
             "categoryId": 8,
             "categoryName": "Clothes & woven decor",
             "count": 1
         },
         {
             "forSelectedId": 4,
             "forSelectedEn": "WOMENS",
             "forSelectedUa": "ЖІНОЧА",
             "forSelectedRu": "Женская",
             "nameId": 331,
             "nameEn": "KNITTED WOVEN TOY",
             "nameUa": "ІГРАШКА В'ЯЗАНА ",
             "nameRu": "ИГРУШКА вязанная",
             "materialId": 332,
             "materialEn": "COTTON",
             "materialUa": "БАВОВНА",
             "materialRu": "Хлопок",
             "subMaterialId": 333,
             "subMaterialEn": "EMBROIDERED",
             "subMaterialUa": "ВИШИТИЙ",
             "subMaterialRu": "вышитый",
             "categoryId": 8,
             "categoryName": "Clothes & woven decor",
             "count": 2
         }
      ]
    },
  "sendFrom": {
         "first_name": "test firstnam112222e",
         "last_name": "test lastname11",
         "company_name": "test companynam11e",
         "full_name": "test firstnam112222e test lastname11",
         "label": "test firstnam112222e test lastname11 test companynam11e"
         },
  "sendFromId": "9"
     },
 },
     "status": "success"
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST /api/order/{id}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Authorization

Example: required Basic + base64 encoded 'user_id:api_token'

URL Parameters

id string

The ID of the order. Example: voluptates

orderFbmId integer optional

Order Id. Example: 19

Body Parameters

receiverName required optional

string Receiver name Example: earum

recipientCompanyName required optional

string Receiver company name Example: quod

receiverEmail required optional

string Receiver email Example: [email protected]

receiverPhone string optional

Receiver phone Example: ut

receiverAddress required optional

string Receiver address line 1 Example: eveniet

receiverAddress1 string optional

Receiver address line 2 Example: quis

receiverCity required optional

string Receiver city Example: suscipit

receiverZip required optional

string Receiver zip number Example: beatae

receiverState required optional

string Receiver state Example: tempora

receiverCountry required optional

string Receiver country (Code iso 2) Example: enim

storageId integer optional

storage Id can get in route "https://system.skladusa.com/api/storage/order-fbm" Example: 13

weightLb numeric optional

Weight in pound Example: iste

weightOz numeric optional

Weight in ounce Example: magni

length numeric optional

Length in sm Example: occaecati

width numeric optional

Width in sm Example: dignissimos

height numeric optional

Height in sm Example: ducimus

comment string optional

Comment Example: et

vatTaxId string optional

VATTAXID Example: porro

insurancesStatus boolean optional true false

Insurance? 0=No; 1=Yes Example: true

insurances numeric optional

Insurance Amount Example: enim

transactionId number optional

Example: 3795.5562501

externalId string optional

External Id max lenth 256 Example: error

apiShipMethod string optional

Ship Method (999_999) Example: possimus

packagingId string optional

External packaging Id Example: ipsa

consolidationOrder required optional

bool Consolidation order ? 0=No; 1=Yes Example: commodi

skladCreateLabel required optional

bool Sklad Create Label for order ? 0=No; 1=Yes Example: vero

userPackType string optional

pack1 - Warehouse discretion, pack2 - Package, pack3 - Bubbles pack, pack4 - Carton Example: non

productsConsolidationData required optional

array Array or object productConsolidationType Example: excepturi

id integer optional

Example: 11

categoryId integer optional

The id of an existing record in the proform_categories table. Example: 8

descrEn string optional

Example: nulla

nameId integer optional

The id of an existing record in the proform_attachments table. Example: 2

forSelectedId integer optional

The id of an existing record in the proform_attachments table. Example: 9

materialId integer optional

The id of an existing record in the proform_attachments table. Example: 9

subMaterialId integer optional

The id of an existing record in the proform_attachments table. Example: 19

hsCode number optional

Example: 350.42576832

price number

Example: 13776.028458123

count integer

Must be at least 1. Example: 84

productsData object[] optional

This field is required when consolidationOrder is 0.

product integer

The id of an existing record in the products table. Example: 1

hsCode number optional

Example: 2.222942

price number optional

Example: 60.3164

description string optional

Example: Consequatur reprehenderit ducimus error qui perferendis.

count integer

Must be at least 1. Example: 79

sendFromId int|null optional

Selected send from address id (може бути не вказано, у такому разі буде використаний перший з створених користувачем) Example: accusamus

productsConsolidationData[][id] integer optional

Element id or null if new Example: 9

productsConsolidationData[][categoryId] required optional

integer Category Id Example: veritatis

productsConsolidationData[][nameId] required optional

integer Name Id Example: dolore

productsConsolidationData[][forSelectedId] integer optional

For Selected Id Example: 17

productsConsolidationData[][materialId] integer optional

Material Id Example: 12

productsConsolidationData[][subMaterialId] integer optional

SubMaterialId Id Example: 9

productsConsolidationData[][hsCode] string optional

HsCode Example: blanditiis

productsConsolidationData[][price] required optional

numeric Product Price Example: tempore

productsConsolidationData[][count] required optional

integer Product quantity Example: et

Make label for order FBM

requires authentication

Example request:

$client = new \GuzzleHttp\Client();
$url = 'https://system.skladusa.com/api/order/est/set-shipstation-code';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'Authorization' => 'required   Basic + base64 encoded \'user_id:api_token\'',
        ],
        'json' => [
            'serviceId' => 'quos',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://system.skladusa.com/api/order/est/set-shipstation-code"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": "required   Basic + base64 encoded &#039;user_id:api_token&#039;",
};

let body = {
    "serviceId": "quos"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "https://system.skladusa.com/api/order/est/set-shipstation-code" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: required   Basic + base64 encoded \&#039;user_id:api_token\&#039;" \
    --data "{
    \"serviceId\": \"quos\"
}"

Example response (200):


{
    "status": "success",
    "data": {
        "id": 143,
        "shipDate": {
            "date": "2022-05-06 14:40:00.000000",
            "timezone_type": 3,
            "timezone": "Europe/Kiev"
        },
        "shippingCosts": "9.01",
        "trackingNumber": "9405536109361289955107",
        "label": "base64 file string"
    }
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST /api/order/{id}/set-shipstation-code

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Authorization

Example: required Basic + base64 encoded 'user_id:api_token'

URL Parameters

id string

The ID of the order. Example: est

orderFbmId integer optional

Order Id. Example: 19

Body Parameters

serviceId required optional

string serviceId from delivery methods. Use /order/{id}/get-delivery-methods before. Example: quos

Orders Express

Dictionaries for express order form.

requires authentication

Example request:

$client = new \GuzzleHttp\Client();
$url = 'https://system.skladusa.com/api/express-orders/dictionaries';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'Authorization' => 'required    \'Basic \' + base64 encoded \'user_id:api_token\'',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://system.skladusa.com/api/express-orders/dictionaries"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": "required    &#039;Basic &#039; + base64 encoded &#039;user_id:api_token&#039;",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

curl --request GET \
    --get "https://system.skladusa.com/api/express-orders/dictionaries" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: required    \&#039;Basic \&#039; + base64 encoded \&#039;user_id:api_token\&#039;"

Example response (200):


{
  "status": "success",
  "data": {
    "countries": [
      "id": 3,
      "label": "Algeria",
      "currencies": [],
      "regions": [],
    ],
    "proformTypes": [
      ...
    ]
  }
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Get NovaPoshtaGlobal warehouse list from customer profile.

requires authentication

Example request:

$client = new \GuzzleHttp\Client();
$url = 'https://system.skladusa.com/api/express-orders/get-npg-warehouse-list';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'Authorization' => 'required   \'Basic \' + base64 encoded \'user_id:api_token\'',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://system.skladusa.com/api/express-orders/get-npg-warehouse-list"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": "required   &#039;Basic &#039; + base64 encoded &#039;user_id:api_token&#039;",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

curl --request GET \
    --get "https://system.skladusa.com/api/express-orders/get-npg-warehouse-list" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: required   \&#039;Basic \&#039; + base64 encoded \&#039;user_id:api_token\&#039;"

Example response (200):


{
  "status": "success",
  "data": [
    {
      "address_type": "Warehouse",
      "ref_warehouse": "1611283d-e1c2-11e3-8c4a-4588968002cf",
      "warehouse_name": "Київ, Київська, Відділення №18...",
      "city_name": "Київ, Київська"
    },
    ...
  ]
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Search cities for NovaPoshtaGlobal.

requires authentication

Example request:

$client = new \GuzzleHttp\Client();
$url = 'https://system.skladusa.com/api/express-orders/find-city-for-npg/soluta/nemo';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'Authorization' => 'required   \'Basic \' + base64 encoded \'user_id:api_token\'',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://system.skladusa.com/api/express-orders/find-city-for-npg/soluta/nemo"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": "required   &#039;Basic &#039; + base64 encoded &#039;user_id:api_token&#039;",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

curl --request GET \
    --get "https://system.skladusa.com/api/express-orders/find-city-for-npg/soluta/nemo" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: required   \&#039;Basic \&#039; + base64 encoded \&#039;user_id:api_token\&#039;"

Example response (200):


{
    "status": "success",
    "data": [
        {
            "label": "Київ, Київська"
        },
        {
            "label": "Київець, Львівська"
        }
    ]
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET /api/express-orders/find-city-for-npg/{query}/{countryCode?}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Authorization

Example: required 'Basic ' + base64 encoded 'user_id:api_token'

URL Parameters

query string

Example: soluta

countryCode string optional

Example: nemo

Search warehouses for NovaPoshtaGlobal by City.

requires authentication

Example request:

$client = new \GuzzleHttp\Client();
$url = 'https://system.skladusa.com/api/express-orders/warehouses-by-city-for-npg/et/iste';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'Authorization' => 'required   \'Basic \' + base64 encoded \'user_id:api_token\'',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://system.skladusa.com/api/express-orders/warehouses-by-city-for-npg/et/iste"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": "required   &#039;Basic &#039; + base64 encoded &#039;user_id:api_token&#039;",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

curl --request GET \
    --get "https://system.skladusa.com/api/express-orders/warehouses-by-city-for-npg/et/iste" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: required   \&#039;Basic \&#039; + base64 encoded \&#039;user_id:api_token\&#039;"

Example response (200):


{
  "status": "success",
  "data": [
    [
      {
        "reference": "1ec09d6b-e1c2-11e3-8c4a-0050568002cf",
        "currentTranslate": {
            "name": "Kyiv, Kyivska, Viddilennia №7...",
            "city": "Kyiv, Kyivska"
          },
      },
      ...
    ]
  ]
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET /api/express-orders/warehouses-by-city-for-npg/{query}/{countryCode?}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Authorization

Example: required 'Basic ' + base64 encoded 'user_id:api_token'

URL Parameters

query string

Example: et

countryCode string optional

Example: iste

Display the specified order express resource.

requires authentication

Example request:

$client = new \GuzzleHttp\Client();
$url = 'https://system.skladusa.com/api/express-orders/voluptas';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'Authorization' => 'required   \'Basic \' + base64 encoded \'user_id:api_token\'',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://system.skladusa.com/api/express-orders/voluptas"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": "required   &#039;Basic &#039; + base64 encoded &#039;user_id:api_token&#039;",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

curl --request GET \
    --get "https://system.skladusa.com/api/express-orders/voluptas" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: required   \&#039;Basic \&#039; + base64 encoded \&#039;user_id:api_token\&#039;"

Example response (200):


{
"data": {
   "id": 143,
   ...
 },
 "status": "success"
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET /api/express-orders/{id}

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Authorization

Example: required 'Basic ' + base64 encoded 'user_id:api_token'

URL Parameters

id string

The ID of the express order. Example: voluptas

orderExpressId integer optional

Order Id. Example: 17

Get tracking history by order id.

requires authentication

Example request:

$client = new \GuzzleHttp\Client();
$url = 'https://system.skladusa.com/api/express-orders/magnam/tracking-history';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'Authorization' => 'required    Basic + base64 encoded \'user_id:api_token\'',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://system.skladusa.com/api/express-orders/magnam/tracking-history"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": "required    Basic + base64 encoded &#039;user_id:api_token&#039;",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

curl --request GET \
    --get "https://system.skladusa.com/api/express-orders/magnam/tracking-history" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: required    Basic + base64 encoded \&#039;user_id:api_token\&#039;"

Example response (200):


{
    "data": {
        "message": "Delivered",
        "history": [
            "Shipping Label Created, USPS Awaiting Item 2021-12-10 14:38:00",
            "Accepted at USPS Origin Facility 2021-12-22 20:25:00",
            "Arrived at USPS Origin Facility 2021-12-22 21:40:00",
            "Departed USPS Origin Facility 2021-12-22 21:52:00",
            "Arrived at USPS Regional Origin Facility 2021-12-24 22:07:00",
            "In Transit to Next Facility 2021-12-28 00:00:00",
            "Arrived at USPS Regional Destination Facility 2021-12-29 15:27:00",
            "Departed USPS Regional Facility 2021-12-30 03:07:00",
            "Arrived at USPS Facility 2021-12-30 04:03:00",
            "Arrived at Post Office 2021-12-30 04:36:00",
            "Out for Delivery 2021-12-30 06:10:00",
            "Delivered, In/At Mailbox 2021-12-30 13:58:00"
        ],
        "trackingNumber": "9400136109361359102933"
    },
    "status": "success"
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET /api/express-orders/{id}/tracking-history

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Authorization

Example: required Basic + base64 encoded 'user_id:api_token'

URL Parameters

id string

The ID of the express order. Example: magnam

orderFbmId integer optional

Order Id. Example: 14

Get Shipping Delivery Price from NPG Api.

requires authentication

Example request:

$client = new \GuzzleHttp\Client();
$url = 'https://system.skladusa.com/api/express-orders/npg-price';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'warehouse_id' => 7,
            'payment_transaction_id' => 2,
            'sender' => [
                'modi',
            ],
            'recipient' => [
                'consequatur',
            ],
            'products' => [
                'et',
            ],
            'proform_packaging' => [
                'aut',
            ],
            'insurance_amount' => 'et',
            'for_consolidation' => false,
            'order_express_id' => 5,
            'vat_number' => 'necessitatibus',
            'promocodes' => [
                [
                    'code' => 'voluptate',
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://system.skladusa.com/api/express-orders/npg-price"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "warehouse_id": 7,
    "payment_transaction_id": 2,
    "sender": [
        "modi"
    ],
    "recipient": [
        "consequatur"
    ],
    "products": [
        "et"
    ],
    "proform_packaging": [
        "aut"
    ],
    "insurance_amount": "et",
    "for_consolidation": false,
    "order_express_id": 5,
    "vat_number": "necessitatibus",
    "promocodes": [
        {
            "code": "voluptate"
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "https://system.skladusa.com/api/express-orders/npg-price" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"warehouse_id\": 7,
    \"payment_transaction_id\": 2,
    \"sender\": [
        \"modi\"
    ],
    \"recipient\": [
        \"consequatur\"
    ],
    \"products\": [
        \"et\"
    ],
    \"proform_packaging\": [
        \"aut\"
    ],
    \"insurance_amount\": \"et\",
    \"for_consolidation\": false,
    \"order_express_id\": 5,
    \"vat_number\": \"necessitatibus\",
    \"promocodes\": [
        {
            \"code\": \"voluptate\"
        }
    ]
}"

Example response (200):


{
    "status": 200,
    "data": {
        "price_variant": [
            {
                "price": 36.63,
                "orderFee": 0,
                "total_price": 36.63,
                "oversize_charge": 0,
                "initial_price": 0,
                "additional_handling_surcharge": 0,
                "out_of_delivery.extra_charge": 0,
                "out_of_delivery.shipping_cost": 0,
                "label": "Cargo",
                "delivery_service_type": "29:cargo"
            }
        ]
    }
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST /api/express-orders/npg-price

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Body Parameters

warehouse_id integer optional

The id of an existing record in the warehouses table. Example: 7

payment_transaction_id integer optional

The id of an existing record in the payment_transactions table. Example: 2

sender string[]

Order Express country_code,city,post_code

country_code string

Example: itaque

post_code string

Example: aspernatur

city string optional

Example: atque

region string optional

Example: facere

address string optional

Example: assumenda

additional_address string optional

Example: adipisci

recipient string[]

Order Express country_code,city,post_code

country_code string

Example: doloremque

post_code string

Example: adipisci

city string optional

Example: accusantium

region string optional

Example: ex

address string optional

Example: sit

additional_address string optional

Example: eos

products string[]

Order Express product data

name string

Example: doloremque

count integer

Example: 13

price number

Example: 3.543642455

proform_packaging string[]

Order Express proform packaging data

weight number

Must be at least 0. Example: 75

length number

Must be at least 0. Example: 19

width number

Example: 34251681.03145

height number

Must be at least 0. Example: 15

packaging_type string optional

Example: himself_packaging

Must be one of:

himself_packaging
fedex_packaging
fedex_envelope_packaging

insurance_amount numeric

Order Express insurance_amount data Example: et

for_consolidation boolean optional true false

Example: false

promocodes object[] optional

@var OrderExpress $orderExpressInstance.

code string

The code of an existing record in the promocodes table. Example: voluptate

order_express_id integer optional

The id of an existing record in the order_express table. Example: 5

vat_number string optional

Example: necessitatibus

Creation label for express order.

requires authentication

Example request:

$client = new \GuzzleHttp\Client();
$url = 'https://system.skladusa.com/api/express-orders/make-label';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'order_express_id' => 6,
            'delivery_service_type' => 'qgyraroxemjrndjwvu',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://system.skladusa.com/api/express-orders/make-label"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "order_express_id": 6,
    "delivery_service_type": "qgyraroxemjrndjwvu"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "https://system.skladusa.com/api/express-orders/make-label" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"order_express_id\": 6,
    \"delivery_service_type\": \"qgyraroxemjrndjwvu\"
}"

Example response (200):


{
    "status": 200,
    "data": {
        "status": true
    }
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST /api/express-orders/make-label

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Body Parameters

order_express_id integer

Order express id Example: 6

delivery_service_type string optional

Must not be greater than 255 characters. Example: qgyraroxemjrndjwvu

Get file by uuid.

requires authentication

Example request:

$client = new \GuzzleHttp\Client();
$url = 'https://system.skladusa.com/api/express-orders/get-file/300963ba-5ab8-3957-83bb-ceae3ee812a3';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://system.skladusa.com/api/express-orders/get-file/300963ba-5ab8-3957-83bb-ceae3ee812a3"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

curl --request GET \
    --get "https://system.skladusa.com/api/express-orders/get-file/300963ba-5ab8-3957-83bb-ceae3ee812a3" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (200):


{
 Файл в ответе
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Create new express order for NovaPoshtaGlobal.

requires authentication

Example request:

$client = new \GuzzleHttp\Client();
$url = 'https://system.skladusa.com/api/express-orders';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'Authorization' => 'required   \'Basic \' + base64 encoded \'user_id:api_token\'',
        ],
        'json' => [
            'total_order_amount' => 24026297.1,
            'from_model' => 'from_order_external',
            'model_id' => 6,
            'delivery_service_id' => 3,
            'status' => 'completed',
            'send_type' => 'by_himself',
            'warehouse_id' => 9,
            'new_post_tracking_number' => 'sppzatopwox',
            'tracking_number' => 'fugiat',
            'sender_contact_name' => 'fuktigntdqlmoycgnemeqke',
            'sender_phone_number' => 'repellendus',
            'recipient_contact_name' => 'r',
            'recipient_phone_number' => '+s$/im',
            'recipient_email' => '[email protected]',
            'recipient_address' => 'qjmllsg',
            'recipient_additional_address' => 'okrcipaankbwyz',
            'recipient_city' => 'mbnnovoydgklwjb',
            'recipient_region' => 'xadsfs',
            'recipient_country_id' => 7,
            'recipient_zip_code' => 'mqarx',
            'recipient_company_name' => 'vbez',
            'recipient_eori_number' => 'go',
            'recipient_currency_id' => 14,
            'delivery_date' => '8494-21-63$/i',
            'available_courier_time' => '35:86|20:01$/i',
            'not_available_courier_time' => '24:90|67:51$/i',
            'vat_number' => 'l',
            'proform_data' => [
                [
                    'handmade' => '0',
                    'item_quantity' => 2079.4601,
                    'item_price' => 9.582,
                    'hs_code' => 'wcsmsnf',
                    'label_full_name' => 'ramhrbcixnxtebbpz',
                    'category_id' => 11,
                    'name_id' => 15,
                    'material_id' => 8,
                ],
            ],
            'proform_packaging' => [
                'package_name' => 'sblikb',
                'weight' => 3002664.9944,
                'length' => 35953.43142862,
                'width' => 160.23,
                'height' => 274111036.3,
            ],
            'insurance_amount' => 341745667.16,
            'packaging_type' => 'fedex_packaging',
            'drop_certification' => false,
            'toxic_substance' => true,
            'freight_cost' => 0.78568,
            'in_draft' => '0',
            'courier_arrival_date' => '3833-45-90$/i',
            'courier_from_to_time' => '66:20|44:32$/i',
            'courier_contact_name' => 'hqqmasdbwhjvatzrttkdgj',
            'courier_contact_phone' => 'dimubmwmntzcfhyhotsxgi',
            'sender_contact_address' => 'ullam',
            'alarm_status' => true,
            'delivery_service_type' => 'lbejeozptadcxahsclgekjpg',
            'recipient_tax_value' => 'quidem',
            'deleted_proform_ids' => [
                'proform_data' => [
                    2,
                ],
            ],
            'promocodes' => [
                [
                    'code' => 'ipsa',
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://system.skladusa.com/api/express-orders"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": "required   &#039;Basic &#039; + base64 encoded &#039;user_id:api_token&#039;",
};

let body = {
    "total_order_amount": 24026297.1,
    "from_model": "from_order_external",
    "model_id": 6,
    "delivery_service_id": 3,
    "status": "completed",
    "send_type": "by_himself",
    "warehouse_id": 9,
    "new_post_tracking_number": "sppzatopwox",
    "tracking_number": "fugiat",
    "sender_contact_name": "fuktigntdqlmoycgnemeqke",
    "sender_phone_number": "repellendus",
    "recipient_contact_name": "r",
    "recipient_phone_number": "+s$\/im",
    "recipient_email": "[email protected]",
    "recipient_address": "qjmllsg",
    "recipient_additional_address": "okrcipaankbwyz",
    "recipient_city": "mbnnovoydgklwjb",
    "recipient_region": "xadsfs",
    "recipient_country_id": 7,
    "recipient_zip_code": "mqarx",
    "recipient_company_name": "vbez",
    "recipient_eori_number": "go",
    "recipient_currency_id": 14,
    "delivery_date": "8494-21-63$\/i",
    "available_courier_time": "35:86|20:01$\/i",
    "not_available_courier_time": "24:90|67:51$\/i",
    "vat_number": "l",
    "proform_data": [
        {
            "handmade": "0",
            "item_quantity": 2079.4601,
            "item_price": 9.582,
            "hs_code": "wcsmsnf",
            "label_full_name": "ramhrbcixnxtebbpz",
            "category_id": 11,
            "name_id": 15,
            "material_id": 8
        }
    ],
    "proform_packaging": {
        "package_name": "sblikb",
        "weight": 3002664.9944,
        "length": 35953.43142862,
        "width": 160.23,
        "height": 274111036.3
    },
    "insurance_amount": 341745667.16,
    "packaging_type": "fedex_packaging",
    "drop_certification": false,
    "toxic_substance": true,
    "freight_cost": 0.78568,
    "in_draft": "0",
    "courier_arrival_date": "3833-45-90$\/i",
    "courier_from_to_time": "66:20|44:32$\/i",
    "courier_contact_name": "hqqmasdbwhjvatzrttkdgj",
    "courier_contact_phone": "dimubmwmntzcfhyhotsxgi",
    "sender_contact_address": "ullam",
    "alarm_status": true,
    "delivery_service_type": "lbejeozptadcxahsclgekjpg",
    "recipient_tax_value": "quidem",
    "deleted_proform_ids": {
        "proform_data": [
            2
        ]
    },
    "promocodes": [
        {
            "code": "ipsa"
        }
    ]
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request PUT \
    "https://system.skladusa.com/api/express-orders" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: required   \&#039;Basic \&#039; + base64 encoded \&#039;user_id:api_token\&#039;" \
    --data "{
    \"total_order_amount\": 24026297.1,
    \"from_model\": \"from_order_external\",
    \"model_id\": 6,
    \"delivery_service_id\": 3,
    \"status\": \"completed\",
    \"send_type\": \"by_himself\",
    \"warehouse_id\": 9,
    \"new_post_tracking_number\": \"sppzatopwox\",
    \"tracking_number\": \"fugiat\",
    \"sender_contact_name\": \"fuktigntdqlmoycgnemeqke\",
    \"sender_phone_number\": \"repellendus\",
    \"recipient_contact_name\": \"r\",
    \"recipient_phone_number\": \"+s$\\/im\",
    \"recipient_email\": \"[email protected]\",
    \"recipient_address\": \"qjmllsg\",
    \"recipient_additional_address\": \"okrcipaankbwyz\",
    \"recipient_city\": \"mbnnovoydgklwjb\",
    \"recipient_region\": \"xadsfs\",
    \"recipient_country_id\": 7,
    \"recipient_zip_code\": \"mqarx\",
    \"recipient_company_name\": \"vbez\",
    \"recipient_eori_number\": \"go\",
    \"recipient_currency_id\": 14,
    \"delivery_date\": \"8494-21-63$\\/i\",
    \"available_courier_time\": \"35:86|20:01$\\/i\",
    \"not_available_courier_time\": \"24:90|67:51$\\/i\",
    \"vat_number\": \"l\",
    \"proform_data\": [
        {
            \"handmade\": \"0\",
            \"item_quantity\": 2079.4601,
            \"item_price\": 9.582,
            \"hs_code\": \"wcsmsnf\",
            \"label_full_name\": \"ramhrbcixnxtebbpz\",
            \"category_id\": 11,
            \"name_id\": 15,
            \"material_id\": 8
        }
    ],
    \"proform_packaging\": {
        \"package_name\": \"sblikb\",
        \"weight\": 3002664.9944,
        \"length\": 35953.43142862,
        \"width\": 160.23,
        \"height\": 274111036.3
    },
    \"insurance_amount\": 341745667.16,
    \"packaging_type\": \"fedex_packaging\",
    \"drop_certification\": false,
    \"toxic_substance\": true,
    \"freight_cost\": 0.78568,
    \"in_draft\": \"0\",
    \"courier_arrival_date\": \"3833-45-90$\\/i\",
    \"courier_from_to_time\": \"66:20|44:32$\\/i\",
    \"courier_contact_name\": \"hqqmasdbwhjvatzrttkdgj\",
    \"courier_contact_phone\": \"dimubmwmntzcfhyhotsxgi\",
    \"sender_contact_address\": \"ullam\",
    \"alarm_status\": true,
    \"delivery_service_type\": \"lbejeozptadcxahsclgekjpg\",
    \"recipient_tax_value\": \"quidem\",
    \"deleted_proform_ids\": {
        \"proform_data\": [
            2
        ]
    },
    \"promocodes\": [
        {
            \"code\": \"ipsa\"
        }
    ]
}"

Example response (200):


{
  "status": "success",
  "data": {
    "id": 3680,
    ...
  }
},

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

PUT /api/express-orders

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Authorization

Example: required 'Basic ' + base64 encoded 'user_id:api_token'

Body Parameters

total_order_amount number optional

Example: 24026297.1

from_model string optional

Example: from_order_external

Must be one of:

from_order_external
from_payment_transaction

model_id integer optional

Example: 6

delivery_service_id integer

Example: 3

status string optional

Example: completed

Must be one of:

completed
in_progress
copy
wait_for_pay
wait_for_making_label

send_type string

Example: by_himself

Must be one of:

by_himself
by_warehouse

warehouse_id integer optional

This field is required when send_type is by_warehouse. Example: 9

new_post_tracking_number string optional

Must not be greater than 255 characters. Example: sppzatopwox

tracking_number string optional

Example: fugiat

sender_contact_name string optional

This field is required when send_type is by_himself. Must not be greater than 255 characters. Example: fuktigntdqlmoycgnemeqke

sender_phone_number string optional

This field is required when send_type is by_himself. Example: repellendus

recipient_contact_name string

Must not be greater than 255 characters. Example: r

recipient_phone_number string

Must match the regex /^(+)?[\s\d-]+(ext.\s\d{3,})?$/im. Example: +s$/im

recipient_email string optional

Must be a valid email address. Must not be greater than 255 characters. Example: [email protected]

recipient_address string

Must not be greater than 255 characters. Example: qjmllsg

recipient_additional_address string optional

Must not be greater than 255 characters. Example: okrcipaankbwyz

recipient_city string

Must not be greater than 255 characters. Example: mbnnovoydgklwjb

recipient_region string

Must not be greater than 255 characters. Example: xadsfs

recipient_country_id integer

The id of an existing record in the countries table. Example: 7

recipient_zip_code string

Must not be greater than 255 characters. Example: mqarx

recipient_company_name string optional

This field is required when recipient_eori_number is present. Must not be greater than 35 characters. Example: vbez

recipient_eori_number string optional

This field is required when recipient_company_name is present. Must not be greater than 255 characters. Example: go

recipient_currency_id integer optional

Example: 14

delivery_date string

Must match the regex /\d{4}-\d{2}-\d{2}$/i. Example: 8494-21-63$/i

available_courier_time string optional

Must match the regex /\d{2}:\d{2}|\d{2}:\d{2}$/i. Example: 35:86|20:01$/i

not_available_courier_time string optional

Must match the regex /\d{2}:\d{2}|\d{2}:\d{2}$/i. Example: 24:90|67:51$/i

vat_number string optional

Must not be greater than 255 characters. Example: l

deleted_proform_ids object optional

proform_data integer[] optional

proform_data object[]

handmade integer

Example: 0

Must be one of:

item_quantity number optional

Example: 2079.4601

item_price number optional

Example: 9.582

hs_code string optional

Must be at least 6 characters. Must not be greater than 255 characters. Example: wcsmsnf

label_full_name string optional

Must not be greater than 255 characters. Example: ramhrbcixnxtebbpz

category_id integer

The id of an existing record in the proform_attachments table. Example: 11

name_id integer

The id of an existing record in the proform_attachments table. Example: 15

material_id integer

The id of an existing record in the proform_attachments table. Example: 8

proform_packaging object optional

package_name string optional

Must not be greater than 255 characters. Example: sblikb

weight number

Example: 3002664.9944

length number

Example: 35953.43142862

width number

Example: 160.23

height number

Example: 274111036.3

insurance_amount number optional

Example: 341745667.16

packaging_type string optional

Example: fedex_packaging

Must be one of:

himself_packaging
fedex_packaging
fedex_envelope_packaging

drop_certification boolean optional true false

This field is required when delivery_service_id is 2. Example: false

toxic_substance boolean optional true false

This field is required when delivery_service_id is 2. Example: true

freight_cost number optional

Example: 0.78568

in_draft integer optional

Example: 0

Must be one of:

courier_arrival_date string optional

Must match the regex /\d{4}-\d{2}-\d{2}$/i. Example: 3833-45-90$/i

courier_from_to_time string optional

Must match the regex /\d{2}:\d{2}|\d{2}:\d{2}$/i. Example: 66:20|44:32$/i

courier_contact_name string optional

Must not be greater than 255 characters. Example: hqqmasdbwhjvatzrttkdgj

courier_contact_phone string optional

Must not be greater than 255 characters. Example: dimubmwmntzcfhyhotsxgi

sender_contact_address string optional

Example: ullam

alarm_status boolean optional true false

Example: true

order_express_country_type string optional

delivery_service_type string optional

Must not be greater than 255 characters. Example: lbejeozptadcxahsclgekjpg

npg object optional

address_type string optional

ref_warehouse string optional

warehouse_name string optional

city_name string optional

recipient_tax_value string optional

Example: quidem

promocodes object[] optional

code string

The code of an existing record in the promocodes table. Example: ipsa

Display a listing of the order express.

requires authentication

Example request:

$client = new \GuzzleHttp\Client();
$url = 'https://system.skladusa.com/api/express-orders';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'Authorization' => 'required    \'Basic \' + base64 encoded \'user_id:api_token\'',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://system.skladusa.com/api/express-orders"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": "required    &#039;Basic &#039; + base64 encoded &#039;user_id:api_token&#039;",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

curl --request GET \
    --get "https://system.skladusa.com/api/express-orders" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: required    \&#039;Basic \&#039; + base64 encoded \&#039;user_id:api_token\&#039;"

Example response (200):


{
  "data": {
    "entities": [
      {
        "id": 3666,
        ...
      },
      ...
    ],
    "pagination": {
      "last": 2,
      "current": 0,
      "numItemsPerPage": 10,
      "first": 1,
      "pageCount": 2,
      "totalCount": 19,
      "pageRange": 2,
      "startPage": 1,
      "endPage": 2,
      "previous": 0,
      "next": 1,
      "pagesInRange": [
          1,
          2
      ],
      "firstPageInRange": 1,
      "lastPageInRange": 2,
      "currentItemCount": 10,
      "firstItemNumber": 11,
      "lastItemNumber": 2
    },
  },
 "status": "success"
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET /api/express-orders

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Authorization

Example: required 'Basic ' + base64 encoded 'user_id:api_token'

URL Parameters

page integer optional

Current page default 1. Example: 18

limit integer optional

Num Items Per Page by default 10 max per page 100 Example: 12

Authorize Pay

Get Authorize popup HTML

requires authentication

Example request:

$client = new \GuzzleHttp\Client();
$url = 'https://system.skladusa.com/api/gateway';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'Authorization' => 'required   Basic + base64 encoded \'user_id:api_token\'',
        ],
        'json' => [
            'sum' => 'omnis',
            'shopName' => 'id',
            'orderId' => 'deserunt',
            'iframeUrl' => 'http://jerde.com/',
            'callBackUrl' => 'http://www.koelpin.biz/suscipit-ratione-itaque-dolorem-quaerat-quas-quia',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://system.skladusa.com/api/gateway"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": "required   Basic + base64 encoded &#039;user_id:api_token&#039;",
};

let body = {
    "sum": "omnis",
    "shopName": "id",
    "orderId": "deserunt",
    "iframeUrl": "http:\/\/jerde.com\/",
    "callBackUrl": "http:\/\/www.koelpin.biz\/suscipit-ratione-itaque-dolorem-quaerat-quas-quia"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "https://system.skladusa.com/api/gateway" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: required   Basic + base64 encoded \&#039;user_id:api_token\&#039;" \
    --data "{
    \"sum\": \"omnis\",
    \"shopName\": \"id\",
    \"orderId\": \"deserunt\",
    \"iframeUrl\": \"http:\\/\\/jerde.com\\/\",
    \"callBackUrl\": \"http:\\/\\/www.koelpin.biz\\/suscipit-ratione-itaque-dolorem-quaerat-quas-quia\"
}"

Example response (200):


{
    "status": "success",
    "data": "HTML"
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST /api/gateway

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Authorization

Example: required Basic + base64 encoded 'user_id:api_token'

Body Parameters

sum required optional

string Pay Amount Example: omnis

shopName required optional

string Shop name Example: id

orderId required optional

string Order Id Example: deserunt

iframeUrl required optional

string iframe Url for authorize.net Example: http://jerde.com/

callBackUrl required optional

string callBackUrl Url for site Example: http://www.koelpin.biz/suscipit-ratione-itaque-dolorem-quaerat-quas-quia

WarehouseStorage

Get possible Warehouse storage.

requires authentication

Example request:

$client = new \GuzzleHttp\Client();
$url = 'https://system.skladusa.com/api/storage/order-fbm';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'Authorization' => 'required    Basic + base64 encoded \'user_id:api_token\'',
        ],
        'json' => [
            'receiverCountry' => 'dolores',
            'receiverZip' => 'atque',
            'consolidationOrder' => 'non',
            'skladCreateLabel' => 'animi',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://system.skladusa.com/api/storage/order-fbm"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": "required    Basic + base64 encoded &#039;user_id:api_token&#039;",
};

let body = {
    "receiverCountry": "dolores",
    "receiverZip": "atque",
    "consolidationOrder": "non",
    "skladCreateLabel": "animi"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "https://system.skladusa.com/api/storage/order-fbm" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: required    Basic + base64 encoded \&#039;user_id:api_token\&#039;" \
    --data "{
    \"receiverCountry\": \"dolores\",
    \"receiverZip\": \"atque\",
    \"consolidationOrder\": \"non\",
    \"skladCreateLabel\": \"animi\"
}"

Example response (200):


{
    "data": [
        {
            "id": 1,
            "name": "Blaine"
        }
    ],
    "status": "success"
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST /api/storage/order-fbm

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Authorization

Example: required Basic + base64 encoded 'user_id:api_token'

Body Parameters

receiverCountry required optional

string Receiver country (Code iso 2) Example: dolores

receiverZip required optional

string Receiver zip number Example: atque

consolidationOrder required optional

bool Consolidation order ? 0=No; 1=Yes Example: non

skladCreateLabel required optional

bool Sklad Create Label for order ? 0=No; 1=Yes Example: animi

OrderSend From

Display a listing of the send from data.

requires authentication

Example request:

$client = new \GuzzleHttp\Client();
$url = 'https://system.skladusa.com/api/order/send-from';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'Authorization' => 'required    Basic + base64 encoded \'user_id:api_token\'',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://system.skladusa.com/api/order/send-from"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": "required    Basic + base64 encoded &#039;user_id:api_token&#039;",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

curl --request GET \
    --get "https://system.skladusa.com/api/order/send-from" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: required    Basic + base64 encoded \&#039;user_id:api_token\&#039;"

Example response (200):


{
   "data": {
     "entities": [
             {
                 "id": 7,
                 "firstName": "test firstnam1e",
                 "lastName": "test lastname1",
                 "companyName": "test companynam1e",
                 "fullName": "test firstnam1e test lastname1",
                 "label": "test firstnam1e test lastname1 test companynam1e"
             },
         ...
   ],
     "pagination": {
     "last": 1,
     "current": 0,
     "numItemsPerPage": 200,
     "first": 1,
     "pageCount": 1,
     "totalCount": 4,
     "pageRange": 1,
     "startPage": 1,
     "endPage": 1,
     "previous": 0,
     "next": 1,
     "pagesInRange": [
         1
         ],
     "firstPageInRange": 1,
     "lastPageInRange": 1,
     "currentItemCount": 200,
     "firstItemNumber": 201,
     "lastItemNumber": 1
   }
   },
   "status": "success"
   }

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

GET /api/order/send-from

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Authorization

Example: required Basic + base64 encoded 'user_id:api_token'

URL Parameters

page integer optional

Current page default 1. Example: 4

Store the specified send from data.

requires authentication

Example request:

$client = new \GuzzleHttp\Client();
$url = 'https://system.skladusa.com/api/order/send-from';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'Authorization' => 'required    Basic + base64 encoded \'user_id:api_token\'',
        ],
        'json' => [
            'firstName' => 'consequatur',
            'lastName' => 'dicta',
            'companyName' => 'necessitatibus',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

const url = new URL(
    "https://system.skladusa.com/api/order/send-from"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": "required    Basic + base64 encoded &#039;user_id:api_token&#039;",
};

let body = {
    "firstName": "consequatur",
    "lastName": "dicta",
    "companyName": "necessitatibus"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

curl --request POST \
    "https://system.skladusa.com/api/order/send-from" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: required    Basic + base64 encoded \&#039;user_id:api_token\&#039;" \
    --data "{
    \"firstName\": \"consequatur\",
    \"lastName\": \"dicta\",
    \"companyName\": \"necessitatibus\"
}"

Example response (200):


{
    "status": 200,
    "data": {
        "id": 10,
        "firstName": "test firstnam112222e",
        "lastName": "test lastname11s",
        "companyName": "test companynam11e",
        "fullName": "test firstnam112222e test lastname11s",
        "label": "test firstnam112222e test lastname11s test companynam11e"
    }
}

Received response:

Request failed with error:



Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Request

POST /api/order/send-from

Headers

Content-Type

Example: application/json

Accept

Example: application/json

Authorization

Example: required Basic + base64 encoded 'user_id:api_token'

Body Parameters

firstName required optional

string Receiver name Example: consequatur

lastName required optional

string Receiver company name Example: dicta

companyName required optional

string Receiver email Example: necessitatibus

Introduction

Authenticating requests

Products

Display a listing of the products.

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Display the specified product resource.

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

URL Parameters

Store a newly created product.

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Body Parameters

Update the specified product resource in storage.

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

URL Parameters

Body Parameters

Proform Data

Display a listing of the proform data.

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

URL Parameters

Display the specified proform data resource.

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

URL Parameters

Search Hs Code by proform options (name_id, material_id)

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Body Parameters

Key Crm

Prepare order data for Key Crm.

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

URL Parameters

Get Rate List for Key Crm

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Body Parameters

Transactions

Display a listing of the user transactions.

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

URL Parameters

Display the specified transaction.

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

URL Parameters

Send tracking number to payment system

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

URL Parameters

Body Parameters

Prepare form for creating order from payment transaction

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

URL Parameters

Orders FBM

Display a listing of the order fbm data.

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

URL Parameters

Display example of the order fbm body response.

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Display a listing of the shipping methods.

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Display the delivery methods for order fbm resource.

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

URL Parameters

Display a listing of the packing types.

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Get packing type price list for order.

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Headers

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request