MENU navbar-image

Introduction

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 'user_id:api_token'",
};

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 \'user_id:api_token\'"

Example response (200):


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

Request      

GET /api/product

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

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

Display the specified product resource.

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://system.skladusa.com/api/product/quisquam';
$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/quisquam"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
curl --request GET \
    --get "https://system.skladusa.com/api/product/quisquam" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: required    Basic + base64 encoded \'user_id:api_token\'"

Example response (200):


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

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: quisquam

productId   integer  optional  

Product Id. Example: 10

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' => 'nulla',
            'title' => 'mollitia',
            'upc' => 'aut',
            'sku' => 'aliquid',
        ],
    ]
);
$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 'user_id:api_token'",
};

let body = {
    "name": "nulla",
    "title": "mollitia",
    "upc": "aut",
    "sku": "aliquid"
};

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 \'user_id:api_token\'" \
    --data "{
    \"name\": \"nulla\",
    \"title\": \"mollitia\",
    \"upc\": \"aut\",
    \"sku\": \"aliquid\"
}"

Example response (200):


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

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: nulla

title   string   

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

upc   string   

B073QK9LZX Example: aut

sku   string   

B072KG8H4M, BT-F10M-HAER Example: aliquid

Update the specified product resource in storage.

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

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

let body = {
    "name": "natus",
    "title": "alias",
    "upc": "rerum",
    "sku": "aut",
    "productPacketType": false
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
curl --request POST \
    "https://system.skladusa.com/api/product/et" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: required    Basic + base64 encoded \'user_id:api_token\'" \
    --data "{
    \"name\": \"natus\",
    \"title\": \"alias\",
    \"upc\": \"rerum\",
    \"sku\": \"aut\",
    \"productPacketType\": false
}"

Example response (200):


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

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: et

productId   integer  optional  

Product Id. Example: 10

Body Parameters

name   string   

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

title   string   

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

upc   string   

B073QK9LZX Example: rerum

sku   string   

B072KG8H4M, BT-F10M-HAER Example: aut

productPacketType   boolean   

(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 'user_id:api_token'",
};

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 \'user_id:api_token\'"

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"
}
 

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: 12

numItemsPerPage   integer  optional  

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

Display the specified proform data resource.

requires authentication

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://system.skladusa.com/api/proforma-data/category/quasi';
$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/quasi"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
curl --request GET \
    --get "https://system.skladusa.com/api/proforma-data/category/quasi" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: required   Basic + base64 encoded \'user_id:api_token\'"

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"
}
 

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: quasi

categoryId   integer  optional  

Proform Category Data ID. Example: 17

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' => 16,
            'materialId' => 19,
        ],
    ]
);
$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 'user_id:api_token'",
};

let body = {
    "nameId": 16,
    "materialId": 19
};

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 \'user_id:api_token\'" \
    --data "{
    \"nameId\": 16,
    \"materialId\": 19
}"

Example response (200):


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

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: 16

materialId   integer  optional  

Proform Data material Id Example: 19

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 'user_id:api_token'",
};

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 \'user_id:api_token\'"

Example response (200):


{
    "status": "success",
    "request": {
        "receiverName": "Bogdan Postavenskyi",
        "receiverEmail": "[email protected]",
        "receiverPhone": "+380 932623600",
        "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": "Bogdan Postavenskyi",
        "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
    }
}
 

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: enim

transaction   string  optional  

transaction number. Example: iusto

etsy   string  optional  

etsy order id. Example: voluptatem

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' => 'dignissimos',
            'length' => 'iusto',
            'height' => 'similique',
            'width' => 'deserunt',
            'weight' => 'praesentium',
            'countryCode' => 'officia',
            'stateCode' => 'est',
            'zipCode' => 'doloremque',
            'city' => 'consequatur',
            'clientPayPal' => 'autem',
        ],
    ]
);
$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 'user_id:api_token'",
};

let body = {
    "senderCountryCode": "dignissimos",
    "length": "iusto",
    "height": "similique",
    "width": "deserunt",
    "weight": "praesentium",
    "countryCode": "officia",
    "stateCode": "est",
    "zipCode": "doloremque",
    "city": "consequatur",
    "clientPayPal": "autem"
};

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 \'user_id:api_token\'" \
    --data "{
    \"senderCountryCode\": \"dignissimos\",
    \"length\": \"iusto\",
    \"height\": \"similique\",
    \"width\": \"deserunt\",
    \"weight\": \"praesentium\",
    \"countryCode\": \"officia\",
    \"stateCode\": \"est\",
    \"zipCode\": \"doloremque\",
    \"city\": \"consequatur\",
    \"clientPayPal\": \"autem\"
}"

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"
            }
        ]
    }
}
 

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: dignissimos

length   required  optional  

string Length,sm. Example: iusto

height   required  optional  

string Height,sm. Example: similique

width   required  optional  

string Width,sm. Example: deserunt

weight   required  optional  

string Weight,kg. Example: praesentium

countryCode   required  optional  

string Country code. Example: officia

stateCode   string  optional  

Need when Country code - US. Example: est

zipCode   required  optional  

string Zip (postal) code. Example: doloremque

city   required  optional  

string City. Example: consequatur

clientPayPal   required  optional  

boolean PayPal client. Example: autem

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 'user_id:api_token'",
};

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 \'user_id:api_token\'"

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"
}
 

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: 8

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/6';
$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/6"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
curl --request GET \
    --get "https://system.skladusa.com/api/transactions/6" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: required    Basic + base64 encoded \'user_id:api_token\'"

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"
}
 

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: 6

Send tracking number to payment system

requires authentication

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://system.skladusa.com/api/transactions/et/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' => 'in',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://system.skladusa.com/api/transactions/et/update-tracking-number"
);

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

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

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
curl --request POST \
    "https://system.skladusa.com/api/transactions/et/update-tracking-number" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: required    Basic + base64 encoded \'user_id:api_token\'" \
    --data "{
    \"tracking-number\": \"in\"
}"

Example response (200):


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

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: et

transactionId   integer  optional  

required. Payment transaction id. Example: 19

Body Parameters

tracking-number   required  optional  

string tracking number Example: in

Prepare form for creating order from payment transaction

requires authentication

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://system.skladusa.com/api/transactions/sequi/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/sequi/create-order"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
curl --request GET \
    --get "https://system.skladusa.com/api/transactions/sequi/create-order" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: required    Basic + base64 encoded \'user_id:api_token\'"

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
}
 

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: sequi

transactionId   integer  optional  

required. Payment transaction id. Example: 18

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 'user_id:api_token'",
};

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 \'user_id:api_token\'"

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,
     "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"
}
 

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: 4

numItemsPerPage   integer  optional  

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

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 'user_id:api_token'",
};

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 \'user_id:api_token\'"

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"
        }
    ]
}
 

Request      

GET /api/order/example

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

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

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 'user_id:api_token'",
};

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 \'user_id:api_token\'"

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"
}
 

Request      

GET /api/shipping-method

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

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

Display the delivery methods for order fbm resource.

requires authentication

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://system.skladusa.com/api/order/sint/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/sint/get-delivery-methods"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
curl --request GET \
    --get "https://system.skladusa.com/api/order/sint/get-delivery-methods" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: required   Basic + base64 encoded \'user_id:api_token\'"

Example response (200):


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

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: sint

orderFbmId   integer  optional  

Order Id. Example: 4

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 'user_id:api_token'",
};

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 \'user_id:api_token\'"

Example response (200):


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

Request      

GET /api/user-pack-type

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

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

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 'user_id:api_token'",
};

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 \'user_id:api_token\'"

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"
}
 

Request      

GET /api/packaging-type

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

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

Display the specified order fbm resource.

requires authentication

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://system.skladusa.com/api/order/ducimus';
$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/ducimus"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
curl --request GET \
    --get "https://system.skladusa.com/api/order/ducimus" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: required   Basic + base64 encoded \'user_id:api_token\'"

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,
     "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"
}
 

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: ducimus

orderFbmId   integer  optional  

Order Id. Example: 2

Get tracking history by order id.

requires authentication

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://system.skladusa.com/api/order/sit/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/sit/track"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
curl --request GET \
    --get "https://system.skladusa.com/api/order/sit/track" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: required    Basic + base64 encoded \'user_id:api_token\'"

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"
}
 

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: sit

orderFbmId   integer  optional  

Order Id. Example: 6

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' => 'inventore',
            'recipientCompanyName' => 'quaerat',
            'receiverEmail' => '[email protected]',
            'receiverPhone' => 'perspiciatis',
            'receiverAddress' => 'aliquam',
            'receiverAddress1' => 'sapiente',
            'receiverCity' => 'ut',
            'receiverZip' => 'ut',
            'receiverState' => 'pariatur',
            'receiverCountry' => 'quisquam',
            'storageId' => 3,
            'weightLb' => 'totam',
            'weightOz' => 'molestiae',
            'length' => 'quia',
            'width' => 'asperiores',
            'height' => 'incidunt',
            'comment' => 'dolor',
            'vatTaxId' => 'consequuntur',
            'insurancesStatus' => true,
            'insurances' => 'similique',
            'transactionId' => 8390466.494406,
            'externalId' => 'asperiores',
            'apiShipMethod' => 'labore',
            'packagingId' => 'sit',
            'consolidationOrder' => 'rerum',
            'skladCreateLabel' => 'est',
            'userPackType' => 'quia',
            'productsConsolidationData' => 'consequuntur',
            'productsData' => [
                'debitis',
            ],
            'sendFromId' => 'voluptatum',
        ],
    ]
);
$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 'user_id:api_token'",
};

let body = {
    "receiverName": "inventore",
    "recipientCompanyName": "quaerat",
    "receiverEmail": "[email protected]",
    "receiverPhone": "perspiciatis",
    "receiverAddress": "aliquam",
    "receiverAddress1": "sapiente",
    "receiverCity": "ut",
    "receiverZip": "ut",
    "receiverState": "pariatur",
    "receiverCountry": "quisquam",
    "storageId": 3,
    "weightLb": "totam",
    "weightOz": "molestiae",
    "length": "quia",
    "width": "asperiores",
    "height": "incidunt",
    "comment": "dolor",
    "vatTaxId": "consequuntur",
    "insurancesStatus": true,
    "insurances": "similique",
    "transactionId": 8390466.494406,
    "externalId": "asperiores",
    "apiShipMethod": "labore",
    "packagingId": "sit",
    "consolidationOrder": "rerum",
    "skladCreateLabel": "est",
    "userPackType": "quia",
    "productsConsolidationData": "consequuntur",
    "productsData": [
        "debitis"
    ],
    "sendFromId": "voluptatum"
};

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 \'user_id:api_token\'" \
    --data "{
    \"receiverName\": \"inventore\",
    \"recipientCompanyName\": \"quaerat\",
    \"receiverEmail\": \"[email protected]\",
    \"receiverPhone\": \"perspiciatis\",
    \"receiverAddress\": \"aliquam\",
    \"receiverAddress1\": \"sapiente\",
    \"receiverCity\": \"ut\",
    \"receiverZip\": \"ut\",
    \"receiverState\": \"pariatur\",
    \"receiverCountry\": \"quisquam\",
    \"storageId\": 3,
    \"weightLb\": \"totam\",
    \"weightOz\": \"molestiae\",
    \"length\": \"quia\",
    \"width\": \"asperiores\",
    \"height\": \"incidunt\",
    \"comment\": \"dolor\",
    \"vatTaxId\": \"consequuntur\",
    \"insurancesStatus\": true,
    \"insurances\": \"similique\",
    \"transactionId\": 8390466.494406,
    \"externalId\": \"asperiores\",
    \"apiShipMethod\": \"labore\",
    \"packagingId\": \"sit\",
    \"consolidationOrder\": \"rerum\",
    \"skladCreateLabel\": \"est\",
    \"userPackType\": \"quia\",
    \"productsConsolidationData\": \"consequuntur\",
    \"productsData\": [
        \"debitis\"
    ],
    \"sendFromId\": \"voluptatum\"
}"

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,
     "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"
}
 

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: inventore

recipientCompanyName   required  optional  

string Receiver company name Example: quaerat

receiverEmail   required  optional  

string Receiver email Example: [email protected]

receiverPhone   string  optional  

Receiver phone Example: perspiciatis

receiverAddress   required  optional  

string Receiver address line 1 Example: aliquam

receiverAddress1   string  optional  

Receiver address line 2 Example: sapiente

receiverCity   required  optional  

string Receiver city Example: ut

receiverZip   required  optional  

string Receiver zip number Example: ut

receiverState   required  optional  

string Receiver state Example: pariatur

receiverCountry   required  optional  

string Receiver country (Code iso 2) Example: quisquam

storageId   integer  optional  

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

weightLb   numeric  optional  

Weight in pound Example: totam

weightOz   numeric  optional  

Weight in ounce Example: molestiae

length   numeric  optional  

Length in sm Example: quia

width   numeric  optional  

Width in sm Example: asperiores

height   numeric  optional  

Height in sm Example: incidunt

comment   string  optional  

Comment Example: dolor

vatTaxId   string  optional  

VATTAXID Example: consequuntur

insurancesStatus   boolean  optional  

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

insurances   numeric  optional  

Insurance Amount Example: similique

transactionId   number  optional  

Example: 8390466.494406

externalId   string  optional  

External Id max lenth 256 Example: asperiores

apiShipMethod   string  optional  

Ship Method (999_999) Example: labore

packagingId   string  optional  

External packaging Id Example: sit

consolidationOrder   required  optional  

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

skladCreateLabel   required  optional  

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

userPackType   string  optional  

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

productsConsolidationData   required  optional  

array Array or object productConsolidationType Example: consequuntur

id   integer  optional  

Element id or null if new Example: 15

categoryId   required  optional  

integer Category Id Example: quia

descrEn   string  optional  

Example: aut

nameId   required  optional  

integer Name Id Example: ut

forSelectedId   integer  optional  

For Selected Id Example: 13

materialId   integer  optional  

Material Id Example: 17

subMaterialId   integer  optional  

SubMaterialId Id Example: 7

hsCode   string  optional  

HsCode Example: sint

price   required  optional  

numeric Product Price Example: unde

count   required  optional  

integer Product quantity Example: et

productsData   integer[]  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: voluptatum

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' => 'adipisci',
            'length' => 'et',
            'height' => 'ut',
            'width' => 'laudantium',
            'weight' => 'neque',
            'countryCode' => 'facilis',
            'stateCode' => 'ut',
            'zipCode' => 'enim',
            'city' => 'fuga',
            'clientPayPal' => 'quae',
        ],
    ]
);
$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 'user_id:api_token'",
};

let body = {
    "senderCountryCode": "adipisci",
    "length": "et",
    "height": "ut",
    "width": "laudantium",
    "weight": "neque",
    "countryCode": "facilis",
    "stateCode": "ut",
    "zipCode": "enim",
    "city": "fuga",
    "clientPayPal": "quae"
};

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 \'user_id:api_token\'" \
    --data "{
    \"senderCountryCode\": \"adipisci\",
    \"length\": \"et\",
    \"height\": \"ut\",
    \"width\": \"laudantium\",
    \"weight\": \"neque\",
    \"countryCode\": \"facilis\",
    \"stateCode\": \"ut\",
    \"zipCode\": \"enim\",
    \"city\": \"fuga\",
    \"clientPayPal\": \"quae\"
}"

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"
                }
            ]
        }
    }
}
 

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: adipisci

length   required  optional  

string Length,sm. Example: et

height   required  optional  

string Height,sm. Example: ut

width   required  optional  

string Width,sm. Example: laudantium

weight   required  optional  

string Weight,kg. Example: neque

countryCode   required  optional  

string Country code. Example: facilis

stateCode   string  optional  

Need when Country code - US. Example: ut

zipCode   required  optional  

string Zip (postal) code. Example: enim

city   required  optional  

string City. Example: fuga

clientPayPal   required  optional  

boolean PayPal client. Example: quae

Update the specified order fbm resource.

requires authentication

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://system.skladusa.com/api/order/accusantium';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'Authorization' => 'required    Basic + base64 encoded \'user_id:api_token\'',
        ],
        'json' => [
            'receiverName' => 'rerum',
            'recipientCompanyName' => 'voluptatem',
            'receiverEmail' => '[email protected]',
            'receiverPhone' => 'omnis',
            'receiverAddress' => 'sed',
            'receiverAddress1' => 'dolor',
            'receiverCity' => 'possimus',
            'receiverZip' => 'laborum',
            'receiverState' => 'sint',
            'receiverCountry' => 'nisi',
            'storageId' => 12,
            'weightLb' => 'impedit',
            'weightOz' => 'non',
            'length' => 'deleniti',
            'width' => 'quasi',
            'height' => 'dolores',
            'comment' => 'non',
            'vatTaxId' => 'velit',
            'insurancesStatus' => false,
            'insurances' => 'non',
            'transactionId' => 1.101287,
            'externalId' => 'nihil',
            'apiShipMethod' => 'rerum',
            'packagingId' => 'cumque',
            'consolidationOrder' => 'molestiae',
            'skladCreateLabel' => 'quam',
            'userPackType' => 'recusandae',
            'productsConsolidationData' => 'tempora',
            'productsData' => [
                'quis',
            ],
            'sendFromId' => 'ullam',
            'productsConsolidationData[][id]' => 13,
            'productsConsolidationData[][categoryId]' => 'in',
            'productsConsolidationData[][nameId]' => 'sed',
            'productsConsolidationData[][forSelectedId]' => 9,
            'productsConsolidationData[][materialId]' => 14,
            'productsConsolidationData[][subMaterialId]' => 1,
            'productsConsolidationData[][hsCode]' => 'vero',
            'productsConsolidationData[][price]' => 'rerum',
            'productsConsolidationData[][count]' => 'aliquid',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://system.skladusa.com/api/order/accusantium"
);

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

let body = {
    "receiverName": "rerum",
    "recipientCompanyName": "voluptatem",
    "receiverEmail": "[email protected]",
    "receiverPhone": "omnis",
    "receiverAddress": "sed",
    "receiverAddress1": "dolor",
    "receiverCity": "possimus",
    "receiverZip": "laborum",
    "receiverState": "sint",
    "receiverCountry": "nisi",
    "storageId": 12,
    "weightLb": "impedit",
    "weightOz": "non",
    "length": "deleniti",
    "width": "quasi",
    "height": "dolores",
    "comment": "non",
    "vatTaxId": "velit",
    "insurancesStatus": false,
    "insurances": "non",
    "transactionId": 1.101287,
    "externalId": "nihil",
    "apiShipMethod": "rerum",
    "packagingId": "cumque",
    "consolidationOrder": "molestiae",
    "skladCreateLabel": "quam",
    "userPackType": "recusandae",
    "productsConsolidationData": "tempora",
    "productsData": [
        "quis"
    ],
    "sendFromId": "ullam",
    "productsConsolidationData[][id]": 13,
    "productsConsolidationData[][categoryId]": "in",
    "productsConsolidationData[][nameId]": "sed",
    "productsConsolidationData[][forSelectedId]": 9,
    "productsConsolidationData[][materialId]": 14,
    "productsConsolidationData[][subMaterialId]": 1,
    "productsConsolidationData[][hsCode]": "vero",
    "productsConsolidationData[][price]": "rerum",
    "productsConsolidationData[][count]": "aliquid"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
curl --request POST \
    "https://system.skladusa.com/api/order/accusantium" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: required    Basic + base64 encoded \'user_id:api_token\'" \
    --data "{
    \"receiverName\": \"rerum\",
    \"recipientCompanyName\": \"voluptatem\",
    \"receiverEmail\": \"[email protected]\",
    \"receiverPhone\": \"omnis\",
    \"receiverAddress\": \"sed\",
    \"receiverAddress1\": \"dolor\",
    \"receiverCity\": \"possimus\",
    \"receiverZip\": \"laborum\",
    \"receiverState\": \"sint\",
    \"receiverCountry\": \"nisi\",
    \"storageId\": 12,
    \"weightLb\": \"impedit\",
    \"weightOz\": \"non\",
    \"length\": \"deleniti\",
    \"width\": \"quasi\",
    \"height\": \"dolores\",
    \"comment\": \"non\",
    \"vatTaxId\": \"velit\",
    \"insurancesStatus\": false,
    \"insurances\": \"non\",
    \"transactionId\": 1.101287,
    \"externalId\": \"nihil\",
    \"apiShipMethod\": \"rerum\",
    \"packagingId\": \"cumque\",
    \"consolidationOrder\": \"molestiae\",
    \"skladCreateLabel\": \"quam\",
    \"userPackType\": \"recusandae\",
    \"productsConsolidationData\": \"tempora\",
    \"productsData\": [
        \"quis\"
    ],
    \"sendFromId\": \"ullam\",
    \"productsConsolidationData[][id]\": 13,
    \"productsConsolidationData[][categoryId]\": \"in\",
    \"productsConsolidationData[][nameId]\": \"sed\",
    \"productsConsolidationData[][forSelectedId]\": 9,
    \"productsConsolidationData[][materialId]\": 14,
    \"productsConsolidationData[][subMaterialId]\": 1,
    \"productsConsolidationData[][hsCode]\": \"vero\",
    \"productsConsolidationData[][price]\": \"rerum\",
    \"productsConsolidationData[][count]\": \"aliquid\"
}"

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,
     "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"
}
 

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: accusantium

orderFbmId   integer  optional  

Order Id. Example: 13

Body Parameters

receiverName   required  optional  

string Receiver name Example: rerum

recipientCompanyName   required  optional  

string Receiver company name Example: voluptatem

receiverEmail   required  optional  

string Receiver email Example: [email protected]

receiverPhone   string  optional  

Receiver phone Example: omnis

receiverAddress   required  optional  

string Receiver address line 1 Example: sed

receiverAddress1   string  optional  

Receiver address line 2 Example: dolor

receiverCity   required  optional  

string Receiver city Example: possimus

receiverZip   required  optional  

string Receiver zip number Example: laborum

receiverState   required  optional  

string Receiver state Example: sint

receiverCountry   required  optional  

string Receiver country (Code iso 2) Example: nisi

storageId   integer  optional  

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

weightLb   numeric  optional  

Weight in pound Example: impedit

weightOz   numeric  optional  

Weight in ounce Example: non

length   numeric  optional  

Length in sm Example: deleniti

width   numeric  optional  

Width in sm Example: quasi

height   numeric  optional  

Height in sm Example: dolores

comment   string  optional  

Comment Example: non

vatTaxId   string  optional  

VATTAXID Example: velit

insurancesStatus   boolean  optional  

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

insurances   numeric  optional  

Insurance Amount Example: non

transactionId   number  optional  

Example: 1.101287

externalId   string  optional  

External Id max lenth 256 Example: nihil

apiShipMethod   string  optional  

Ship Method (999_999) Example: rerum

packagingId   string  optional  

External packaging Id Example: cumque

consolidationOrder   required  optional  

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

skladCreateLabel   required  optional  

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

userPackType   string  optional  

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

productsConsolidationData   required  optional  

array Array or object productConsolidationType Example: tempora

id   integer  optional  

Example: 16

categoryId   integer  optional  

Example: 13

descrEn   string  optional  

Example: aut

nameId   integer  optional  

Example: 20

forSelectedId   integer  optional  

Example: 8

materialId   integer  optional  

Example: 14

subMaterialId   integer  optional  

Example: 17

hsCode   number  optional  

Example: 3.3493

price   number   

Example: 2475.81602

count   integer   

Must be at least 1. Example: 86

productsData   integer[]  optional  

This field is required when consolidationOrder is 0.

product   integer   

Example: 2

hsCode   number  optional  

Example: 365904807.22667

price   number  optional  

Example: 0.2131292

description   string  optional  

Example: Atque dolor blanditiis sed aperiam non.

count   integer   

Must be at least 1. Example: 12

sendFromId   int|null  optional  

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

productsConsolidationData[][id]   integer  optional  

Element id or null if new Example: 13

productsConsolidationData[][categoryId]   required  optional  

integer Category Id Example: in

productsConsolidationData[][nameId]   required  optional  

integer Name Id Example: sed

productsConsolidationData[][forSelectedId]   integer  optional  

For Selected Id Example: 9

productsConsolidationData[][materialId]   integer  optional  

Material Id Example: 14

productsConsolidationData[][subMaterialId]   integer  optional  

SubMaterialId Id Example: 1

productsConsolidationData[][hsCode]   string  optional  

HsCode Example: vero

productsConsolidationData[][price]   required  optional  

numeric Product Price Example: rerum

productsConsolidationData[][count]   required  optional  

integer Product quantity Example: aliquid

Make label for order FBM

requires authentication

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://system.skladusa.com/api/order/molestias/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' => 'occaecati',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://system.skladusa.com/api/order/molestias/set-shipstation-code"
);

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

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

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
curl --request POST \
    "https://system.skladusa.com/api/order/molestias/set-shipstation-code" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: required   Basic + base64 encoded \'user_id:api_token\'" \
    --data "{
    \"serviceId\": \"occaecati\"
}"

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"
    }
}
 

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: molestias

orderFbmId   integer  optional  

Order Id. Example: 20

Body Parameters

serviceId   required  optional  

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

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' => 'eaque',
            'shopName' => 'quis',
            'orderId' => 'voluptas',
            'iframeUrl' => 'https://halvorson.com/suscipit-voluptas-consectetur-quasi-explicabo-qui.html',
            'callBackUrl' => 'https://www.schoen.com/ut-dolorum-provident-asperiores-dolorum-tempora',
        ],
    ]
);
$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 'user_id:api_token'",
};

let body = {
    "sum": "eaque",
    "shopName": "quis",
    "orderId": "voluptas",
    "iframeUrl": "https:\/\/halvorson.com\/suscipit-voluptas-consectetur-quasi-explicabo-qui.html",
    "callBackUrl": "https:\/\/www.schoen.com\/ut-dolorum-provident-asperiores-dolorum-tempora"
};

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 \'user_id:api_token\'" \
    --data "{
    \"sum\": \"eaque\",
    \"shopName\": \"quis\",
    \"orderId\": \"voluptas\",
    \"iframeUrl\": \"https:\\/\\/halvorson.com\\/suscipit-voluptas-consectetur-quasi-explicabo-qui.html\",
    \"callBackUrl\": \"https:\\/\\/www.schoen.com\\/ut-dolorum-provident-asperiores-dolorum-tempora\"
}"

Example response (200):


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

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: eaque

shopName   required  optional  

string Shop name Example: quis

orderId   required  optional  

string Order Id Example: voluptas

iframeUrl   required  optional  

string iframe Url for authorize.net Example: https://halvorson.com/suscipit-voluptas-consectetur-quasi-explicabo-qui.html

callBackUrl   required  optional  

string callBackUrl Url for site Example: https://www.schoen.com/ut-dolorum-provident-asperiores-dolorum-tempora

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' => 'quibusdam',
            'receiverZip' => 'itaque',
            'consolidationOrder' => 'placeat',
            'skladCreateLabel' => 'doloribus',
        ],
    ]
);
$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 'user_id:api_token'",
};

let body = {
    "receiverCountry": "quibusdam",
    "receiverZip": "itaque",
    "consolidationOrder": "placeat",
    "skladCreateLabel": "doloribus"
};

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 \'user_id:api_token\'" \
    --data "{
    \"receiverCountry\": \"quibusdam\",
    \"receiverZip\": \"itaque\",
    \"consolidationOrder\": \"placeat\",
    \"skladCreateLabel\": \"doloribus\"
}"

Example response (200):


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

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: quibusdam

receiverZip   required  optional  

string Receiver zip number Example: itaque

consolidationOrder   required  optional  

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

skladCreateLabel   required  optional  

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

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 'user_id:api_token'",
};

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 \'user_id:api_token\'"

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"
   }
 

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: 20

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' => 'accusamus',
            'lastName' => 'accusantium',
            'companyName' => 'facere',
        ],
    ]
);
$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 'user_id:api_token'",
};

let body = {
    "firstName": "accusamus",
    "lastName": "accusantium",
    "companyName": "facere"
};

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 \'user_id:api_token\'" \
    --data "{
    \"firstName\": \"accusamus\",
    \"lastName\": \"accusantium\",
    \"companyName\": \"facere\"
}"

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"
    }
}
 

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: accusamus

lastName   required  optional  

string Receiver company name Example: accusantium

companyName   required  optional  

string Receiver email Example: facere