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

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/sunt" \
    --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: sunt

productId   integer  optional  

Product Id. Example: 4

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' => 'occaecati',
            'title' => 'animi',
            'upc' => 'officia',
            'sku' => 'aut',
        ],
    ]
);
$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": "occaecati",
    "title": "animi",
    "upc": "officia",
    "sku": "aut"
};

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\": \"occaecati\",
    \"title\": \"animi\",
    \"upc\": \"officia\",
    \"sku\": \"aut\"
}"

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

title   string   

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

upc   string   

B073QK9LZX Example: officia

sku   string   

B072KG8H4M, BT-F10M-HAER Example: aut

Update the specified product resource in storage.

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

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

let body = {
    "name": "labore",
    "title": "et",
    "upc": "minus",
    "sku": "tenetur",
    "productPacketType": true
};

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

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

productId   integer  optional  

Product Id. Example: 17

Body Parameters

name   string   

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

title   string   

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

upc   string   

B073QK9LZX Example: minus

sku   string   

B072KG8H4M, BT-F10M-HAER Example: tenetur

productPacketType   boolean   

(0 | 1) Example: true

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

numItemsPerPage   integer  optional  

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

Display the specified proform data resource.

requires authentication

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

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/odit" \
    --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: odit

categoryId   integer  optional  

Proform Category Data ID. Example: 19

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' => 12,
            'materialId' => 3,
        ],
    ]
);
$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": 12,
    "materialId": 3
};

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\": 12,
    \"materialId\": 3
}"

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

materialId   integer  optional  

Proform Data material Id Example: 3

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

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

transaction   string  optional  

transaction number. Example: fugit

etsy   string  optional  

etsy order id. Example: velit

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' => 'voluptates',
            'length' => 'laudantium',
            'height' => 'et',
            'width' => 'incidunt',
            'weight' => 'sequi',
            'countryCode' => 'expedita',
            'stateCode' => 'ea',
            'zipCode' => 'et',
            'city' => 'et',
            'clientPayPal' => 'unde',
        ],
    ]
);
$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": "voluptates",
    "length": "laudantium",
    "height": "et",
    "width": "incidunt",
    "weight": "sequi",
    "countryCode": "expedita",
    "stateCode": "ea",
    "zipCode": "et",
    "city": "et",
    "clientPayPal": "unde"
};

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\": \"voluptates\",
    \"length\": \"laudantium\",
    \"height\": \"et\",
    \"width\": \"incidunt\",
    \"weight\": \"sequi\",
    \"countryCode\": \"expedita\",
    \"stateCode\": \"ea\",
    \"zipCode\": \"et\",
    \"city\": \"et\",
    \"clientPayPal\": \"unde\"
}"

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

length   required  optional  

string Length,sm. Example: laudantium

height   required  optional  

string Height,sm. Example: et

width   required  optional  

string Width,sm. Example: incidunt

weight   required  optional  

string Weight,kg. Example: sequi

countryCode   required  optional  

string Country code. Example: expedita

stateCode   string  optional  

Need when Country code - US. Example: ea

zipCode   required  optional  

string Zip (postal) code. Example: et

city   required  optional  

string City. Example: et

clientPayPal   required  optional  

boolean PayPal client. Example: unde

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

numItemsPerPage   integer  optional  

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

Display the specified transaction.

requires authentication

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

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

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

Send tracking number to payment system

requires authentication

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

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
curl --request POST \
    "https://system.skladusa.com/api/transactions/molestiae/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\": \"et\"
}"

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

transactionId   integer  optional  

required. Payment transaction id. Example: 6

Body Parameters

tracking-number   required  optional  

string tracking number Example: et

Prepare form for creating order from payment transaction

requires authentication

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

transactionId   integer  optional  

required. Payment transaction id. Example: 1

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

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/est/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/est/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/est/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: est

orderFbmId   integer  optional  

Order Id. Example: 1

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/ut';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'Authorization' => 'required   Basic + base64 encoded \'user_id:api_token\'',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://system.skladusa.com/api/order/ut"
);

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/ut" \
    --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: ut

orderFbmId   integer  optional  

Order Id. Example: 3

Get tracking history by order id.

requires authentication

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

orderFbmId   integer  optional  

Order Id. Example: 11

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' => 'et',
            'recipientCompanyName' => 'sapiente',
            'receiverEmail' => '[email protected]',
            'receiverPhone' => 'exercitationem',
            'receiverAddress' => 'facere',
            'receiverAddress1' => 'nobis',
            'receiverCity' => 'voluptate',
            'receiverZip' => 'repudiandae',
            'receiverState' => 'officia',
            'receiverCountry' => 'amet',
            'storageId' => 15,
            'weightLb' => 'porro',
            'weightOz' => 'adipisci',
            'length' => 'in',
            'width' => 'nam',
            'height' => 'culpa',
            'comment' => 'molestiae',
            'vatTaxId' => 'hic',
            'insurancesStatus' => false,
            'insurances' => 'quis',
            'transactionId' => 88.1034673,
            'externalId' => 'et',
            'apiShipMethod' => 'voluptate',
            'packagingId' => 'occaecati',
            'consolidationOrder' => 'quam',
            'skladCreateLabel' => 'debitis',
            'userPackType' => 'suscipit',
            'productsConsolidationData' => 'tempora',
            'sendFromId' => 'quo',
            'productsData' => [
                [
                    'product' => '2321',
                    'hsCode' => '324325SDA.001',
                    'price' => '3.09',
                    'description' => 'Product description text for int.',
                    'count' => '2',
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://system.skladusa.com/api/order"
);

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

let body = {
    "receiverName": "et",
    "recipientCompanyName": "sapiente",
    "receiverEmail": "[email protected]",
    "receiverPhone": "exercitationem",
    "receiverAddress": "facere",
    "receiverAddress1": "nobis",
    "receiverCity": "voluptate",
    "receiverZip": "repudiandae",
    "receiverState": "officia",
    "receiverCountry": "amet",
    "storageId": 15,
    "weightLb": "porro",
    "weightOz": "adipisci",
    "length": "in",
    "width": "nam",
    "height": "culpa",
    "comment": "molestiae",
    "vatTaxId": "hic",
    "insurancesStatus": false,
    "insurances": "quis",
    "transactionId": 88.1034673,
    "externalId": "et",
    "apiShipMethod": "voluptate",
    "packagingId": "occaecati",
    "consolidationOrder": "quam",
    "skladCreateLabel": "debitis",
    "userPackType": "suscipit",
    "productsConsolidationData": "tempora",
    "sendFromId": "quo",
    "productsData": [
        {
            "product": "2321",
            "hsCode": "324325SDA.001",
            "price": "3.09",
            "description": "Product description text for int.",
            "count": "2"
        }
    ]
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
curl --request PUT \
    "https://system.skladusa.com/api/order" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: required    Basic + base64 encoded \'user_id:api_token\'" \
    --data "{
    \"receiverName\": \"et\",
    \"recipientCompanyName\": \"sapiente\",
    \"receiverEmail\": \"[email protected]\",
    \"receiverPhone\": \"exercitationem\",
    \"receiverAddress\": \"facere\",
    \"receiverAddress1\": \"nobis\",
    \"receiverCity\": \"voluptate\",
    \"receiverZip\": \"repudiandae\",
    \"receiverState\": \"officia\",
    \"receiverCountry\": \"amet\",
    \"storageId\": 15,
    \"weightLb\": \"porro\",
    \"weightOz\": \"adipisci\",
    \"length\": \"in\",
    \"width\": \"nam\",
    \"height\": \"culpa\",
    \"comment\": \"molestiae\",
    \"vatTaxId\": \"hic\",
    \"insurancesStatus\": false,
    \"insurances\": \"quis\",
    \"transactionId\": 88.1034673,
    \"externalId\": \"et\",
    \"apiShipMethod\": \"voluptate\",
    \"packagingId\": \"occaecati\",
    \"consolidationOrder\": \"quam\",
    \"skladCreateLabel\": \"debitis\",
    \"userPackType\": \"suscipit\",
    \"productsConsolidationData\": \"tempora\",
    \"sendFromId\": \"quo\",
    \"productsData\": [
        {
            \"product\": \"2321\",
            \"hsCode\": \"324325SDA.001\",
            \"price\": \"3.09\",
            \"description\": \"Product description text for int.\",
            \"count\": \"2\"
        }
    ]
}"

Example response (200):


{
"data": [
 {
 "order": {
     "id": 143,
     "receiverName": "receiverName",
     "recipientCompanyName": "recipientCompanyName",
     "createdAtStr": "2022-05-05 13:58:38",
     "receiverEmail": "[email protected]",
     "receiverAddress": "receiverAddress",
     "receiverCity": "receiverCity",
     "receiverZip": "receiverZip",
     "receiverState": "receiverState",
     "receiverCountry": "Ukraine",
     "receiverPhone": "0989701676",
     "comment": null,
     "weightLb": 11,
     "weightOz": 4,
     "length": 20,
     "width": 180,
     "height": 20,
     "consolidationOrder": false,
     "skladCreateLabel": true,
     "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: et

recipientCompanyName   required  optional  

string Receiver company name Example: sapiente

receiverEmail   required  optional  

string Receiver email Example: [email protected]

receiverPhone   string  optional  

Receiver phone Example: exercitationem

receiverAddress   required  optional  

string Receiver address line 1 Example: facere

receiverAddress1   string  optional  

Receiver address line 2 Example: nobis

receiverCity   required  optional  

string Receiver city Example: voluptate

receiverZip   required  optional  

string Receiver zip number Example: repudiandae

receiverState   required  optional  

string Receiver state Example: officia

receiverCountry   required  optional  

string Receiver country (Code iso 2) Example: amet

storageId   integer  optional  

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

weightLb   numeric  optional  

Weight in pound Example: porro

weightOz   numeric  optional  

Weight in ounce Example: adipisci

length   numeric  optional  

Length in sm Example: in

width   numeric  optional  

Width in sm Example: nam

height   numeric  optional  

Height in sm Example: culpa

comment   string  optional  

Comment Example: molestiae

vatTaxId   string  optional  

VATTAXID Example: hic

insurancesStatus   boolean  optional  

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

insurances   numeric  optional  

Insurance Amount Example: quis

transactionId   number  optional  

Example: 88.1034673

externalId   string  optional  

External Id max lenth 256 Example: et

apiShipMethod   string  optional  

Ship Method (999_999) Example: voluptate

packagingId   string  optional  

External packaging Id Example: occaecati

consolidationOrder   required  optional  

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

skladCreateLabel   required  optional  

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

userPackType   string  optional  

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

productsConsolidationData   required  optional  

array Array or object productConsolidationType Example: tempora

id   integer  optional  

Element id or null if new Example: 11

categoryId   required  optional  

integer Category Id Example: reprehenderit

descrEn   string  optional  

Example: aut

nameId   required  optional  

integer Name Id Example: nostrum

forSelectedId   integer  optional  

For Selected Id Example: 7

materialId   integer  optional  

Material Id Example: 13

subMaterialId   integer  optional  

SubMaterialId Id Example: 9

hsCode   string  optional  

HsCode Example: et

price   required  optional  

numeric Product Price Example: et

count   required  optional  

integer Product quantity Example: dolorem

productsData   object[]  optional  

This field is required when consolidationOrder is 0.

product   required  optional  

integer Product product_id Example: 2321

hsCode   optional  optional  

string Product hs_code Example: 324325SDA.001

price   numeric  optional  

Product item_price Example: 3.09

description   required  optional  

integer Product item_description Example: Product description text for int.

count   required  optional  

numeric Product quantity Example: 2

sendFromId   int|null  optional  

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

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' => 'dolor',
            'length' => 'sit',
            'height' => 'aut',
            'width' => 'minima',
            'weight' => 'aut',
            'countryCode' => 'provident',
            'stateCode' => 'quia',
            'zipCode' => 'qui',
            'city' => 'facere',
            'clientPayPal' => 'maxime',
        ],
    ]
);
$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": "dolor",
    "length": "sit",
    "height": "aut",
    "width": "minima",
    "weight": "aut",
    "countryCode": "provident",
    "stateCode": "quia",
    "zipCode": "qui",
    "city": "facere",
    "clientPayPal": "maxime"
};

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\": \"dolor\",
    \"length\": \"sit\",
    \"height\": \"aut\",
    \"width\": \"minima\",
    \"weight\": \"aut\",
    \"countryCode\": \"provident\",
    \"stateCode\": \"quia\",
    \"zipCode\": \"qui\",
    \"city\": \"facere\",
    \"clientPayPal\": \"maxime\"
}"

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

length   required  optional  

string Length,sm. Example: sit

height   required  optional  

string Height,sm. Example: aut

width   required  optional  

string Width,sm. Example: minima

weight   required  optional  

string Weight,kg. Example: aut

countryCode   required  optional  

string Country code. Example: provident

stateCode   string  optional  

Need when Country code - US. Example: quia

zipCode   required  optional  

string Zip (postal) code. Example: qui

city   required  optional  

string City. Example: facere

clientPayPal   required  optional  

boolean PayPal client. Example: maxime

Update the specified order fbm resource.

requires authentication

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://system.skladusa.com/api/order/perspiciatis';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'Authorization' => 'required    Basic + base64 encoded \'user_id:api_token\'',
        ],
        'json' => [
            'receiverName' => 'maiores',
            'recipientCompanyName' => 'perspiciatis',
            'receiverEmail' => '[email protected]',
            'receiverPhone' => 'accusamus',
            'receiverAddress' => 'deserunt',
            'receiverAddress1' => 'fugit',
            'receiverCity' => 'veniam',
            'receiverZip' => 'enim',
            'receiverState' => 'consequuntur',
            'receiverCountry' => 'aut',
            'storageId' => 9,
            'weightLb' => 'rerum',
            'weightOz' => 'dignissimos',
            'length' => 'minima',
            'width' => 'non',
            'height' => 'mollitia',
            'comment' => 'dolorem',
            'vatTaxId' => 'qui',
            'insurancesStatus' => false,
            'insurances' => 'voluptas',
            'transactionId' => 98957.42816899,
            'externalId' => 'consectetur',
            'apiShipMethod' => 'eaque',
            'packagingId' => 'vel',
            'consolidationOrder' => 'molestias',
            'skladCreateLabel' => 'odit',
            'userPackType' => 'ipsa',
            'productsConsolidationData' => 'sint',
            'sendFromId' => 'a',
            'productsData' => [
                [
                    'product' => 7,
                    'hsCode' => 16087.162059,
                    'price' => 313401569.3,
                    'description' => 'Quisquam pariatur mollitia sed officiis eos id.',
                    'count' => 67,
                ],
            ],
            'productsConsolidationData[][id]' => 14,
            'productsConsolidationData[][categoryId]' => 'quia',
            'productsConsolidationData[][nameId]' => 'modi',
            'productsConsolidationData[][forSelectedId]' => 2,
            'productsConsolidationData[][materialId]' => 16,
            'productsConsolidationData[][subMaterialId]' => 7,
            'productsConsolidationData[][hsCode]' => 'atque',
            'productsConsolidationData[][price]' => 'et',
            'productsConsolidationData[][count]' => 'architecto',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://system.skladusa.com/api/order/perspiciatis"
);

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

let body = {
    "receiverName": "maiores",
    "recipientCompanyName": "perspiciatis",
    "receiverEmail": "[email protected]",
    "receiverPhone": "accusamus",
    "receiverAddress": "deserunt",
    "receiverAddress1": "fugit",
    "receiverCity": "veniam",
    "receiverZip": "enim",
    "receiverState": "consequuntur",
    "receiverCountry": "aut",
    "storageId": 9,
    "weightLb": "rerum",
    "weightOz": "dignissimos",
    "length": "minima",
    "width": "non",
    "height": "mollitia",
    "comment": "dolorem",
    "vatTaxId": "qui",
    "insurancesStatus": false,
    "insurances": "voluptas",
    "transactionId": 98957.42816899,
    "externalId": "consectetur",
    "apiShipMethod": "eaque",
    "packagingId": "vel",
    "consolidationOrder": "molestias",
    "skladCreateLabel": "odit",
    "userPackType": "ipsa",
    "productsConsolidationData": "sint",
    "sendFromId": "a",
    "productsData": [
        {
            "product": 7,
            "hsCode": 16087.162059,
            "price": 313401569.3,
            "description": "Quisquam pariatur mollitia sed officiis eos id.",
            "count": 67
        }
    ],
    "productsConsolidationData[][id]": 14,
    "productsConsolidationData[][categoryId]": "quia",
    "productsConsolidationData[][nameId]": "modi",
    "productsConsolidationData[][forSelectedId]": 2,
    "productsConsolidationData[][materialId]": 16,
    "productsConsolidationData[][subMaterialId]": 7,
    "productsConsolidationData[][hsCode]": "atque",
    "productsConsolidationData[][price]": "et",
    "productsConsolidationData[][count]": "architecto"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
curl --request POST \
    "https://system.skladusa.com/api/order/perspiciatis" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: required    Basic + base64 encoded \'user_id:api_token\'" \
    --data "{
    \"receiverName\": \"maiores\",
    \"recipientCompanyName\": \"perspiciatis\",
    \"receiverEmail\": \"[email protected]\",
    \"receiverPhone\": \"accusamus\",
    \"receiverAddress\": \"deserunt\",
    \"receiverAddress1\": \"fugit\",
    \"receiverCity\": \"veniam\",
    \"receiverZip\": \"enim\",
    \"receiverState\": \"consequuntur\",
    \"receiverCountry\": \"aut\",
    \"storageId\": 9,
    \"weightLb\": \"rerum\",
    \"weightOz\": \"dignissimos\",
    \"length\": \"minima\",
    \"width\": \"non\",
    \"height\": \"mollitia\",
    \"comment\": \"dolorem\",
    \"vatTaxId\": \"qui\",
    \"insurancesStatus\": false,
    \"insurances\": \"voluptas\",
    \"transactionId\": 98957.42816899,
    \"externalId\": \"consectetur\",
    \"apiShipMethod\": \"eaque\",
    \"packagingId\": \"vel\",
    \"consolidationOrder\": \"molestias\",
    \"skladCreateLabel\": \"odit\",
    \"userPackType\": \"ipsa\",
    \"productsConsolidationData\": \"sint\",
    \"sendFromId\": \"a\",
    \"productsData\": [
        {
            \"product\": 7,
            \"hsCode\": 16087.162059,
            \"price\": 313401569.3,
            \"description\": \"Quisquam pariatur mollitia sed officiis eos id.\",
            \"count\": 67
        }
    ],
    \"productsConsolidationData[][id]\": 14,
    \"productsConsolidationData[][categoryId]\": \"quia\",
    \"productsConsolidationData[][nameId]\": \"modi\",
    \"productsConsolidationData[][forSelectedId]\": 2,
    \"productsConsolidationData[][materialId]\": 16,
    \"productsConsolidationData[][subMaterialId]\": 7,
    \"productsConsolidationData[][hsCode]\": \"atque\",
    \"productsConsolidationData[][price]\": \"et\",
    \"productsConsolidationData[][count]\": \"architecto\"
}"

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

orderFbmId   integer  optional  

Order Id. Example: 18

Body Parameters

receiverName   required  optional  

string Receiver name Example: maiores

recipientCompanyName   required  optional  

string Receiver company name Example: perspiciatis

receiverEmail   required  optional  

string Receiver email Example: [email protected]

receiverPhone   string  optional  

Receiver phone Example: accusamus

receiverAddress   required  optional  

string Receiver address line 1 Example: deserunt

receiverAddress1   string  optional  

Receiver address line 2 Example: fugit

receiverCity   required  optional  

string Receiver city Example: veniam

receiverZip   required  optional  

string Receiver zip number Example: enim

receiverState   required  optional  

string Receiver state Example: consequuntur

receiverCountry   required  optional  

string Receiver country (Code iso 2) Example: aut

storageId   integer  optional  

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

weightLb   numeric  optional  

Weight in pound Example: rerum

weightOz   numeric  optional  

Weight in ounce Example: dignissimos

length   numeric  optional  

Length in sm Example: minima

width   numeric  optional  

Width in sm Example: non

height   numeric  optional  

Height in sm Example: mollitia

comment   string  optional  

Comment Example: dolorem

vatTaxId   string  optional  

VATTAXID Example: qui

insurancesStatus   boolean  optional  

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

insurances   numeric  optional  

Insurance Amount Example: voluptas

transactionId   number  optional  

Example: 98957.42816899

externalId   string  optional  

External Id max lenth 256 Example: consectetur

apiShipMethod   string  optional  

Ship Method (999_999) Example: eaque

packagingId   string  optional  

External packaging Id Example: vel

consolidationOrder   required  optional  

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

skladCreateLabel   required  optional  

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

userPackType   string  optional  

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

productsConsolidationData   required  optional  

array Array or object productConsolidationType Example: sint

id   integer  optional  

Example: 20

categoryId   integer  optional  

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

descrEn   string  optional  

Example: ut

nameId   integer  optional  

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

forSelectedId   integer  optional  

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

materialId   integer  optional  

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

subMaterialId   integer  optional  

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

hsCode   number  optional  

Example: 10264260.3

price   number   

Example: 2.74

count   integer   

Must be at least 1. Example: 44

productsData   object[]  optional  

This field is required when consolidationOrder is 0.

product   integer   

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

hsCode   number  optional  

Example: 16087.162059

price   number  optional  

Example: 313401569.3

description   string  optional  

Example: Quisquam pariatur mollitia sed officiis eos id.

count   integer   

Must be at least 1. Example: 67

sendFromId   int|null  optional  

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

productsConsolidationData[][id]   integer  optional  

Element id or null if new Example: 14

productsConsolidationData[][categoryId]   required  optional  

integer Category Id Example: quia

productsConsolidationData[][nameId]   required  optional  

integer Name Id Example: modi

productsConsolidationData[][forSelectedId]   integer  optional  

For Selected Id Example: 2

productsConsolidationData[][materialId]   integer  optional  

Material Id Example: 16

productsConsolidationData[][subMaterialId]   integer  optional  

SubMaterialId Id Example: 7

productsConsolidationData[][hsCode]   string  optional  

HsCode Example: atque

productsConsolidationData[][price]   required  optional  

numeric Product Price Example: et

productsConsolidationData[][count]   required  optional  

integer Product quantity Example: architecto

Make label for order FBM

requires authentication

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

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

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

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

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

orderFbmId   integer  optional  

Order Id. Example: 19

Body Parameters

serviceId   required  optional  

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

Orders Express

Dictionaries for express order form.

requires authentication

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

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": "required    '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/express-orders/dictionaries" \
    --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": {
    "countries": [
      "id": 3,
      "label": "Algeria",
      "currencies": [],
      "regions": [],
    ],
    "proformTypes": [
      ...
    ]
  }
}
 

Request      

GET /api/express-orders/dictionaries

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

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

Get NovaPoshtaGlobal warehouse list from customer profile.

requires authentication

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

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": "required   '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/express-orders/get-npg-warehouse-list" \
    --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": [
    {
      "address_type": "Warehouse",
      "ref_warehouse": "1611283d-e1c2-11e3-8c4a-4588968002cf",
      "warehouse_name": "Київ, Київська, Відділення №18...",
      "city_name": "Київ, Київська"
    },
    ...
  ]
}
 

Request      

GET /api/express-orders/get-npg-warehouse-list

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

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

Search cities for NovaPoshtaGlobal.

requires authentication

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

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/express-orders/find-city-for-npg/id/aut" \
    --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": [
        {
            "label": "Київ, Київська"
        },
        {
            "label": "Київець, Львівська"
        }
    ]
}
 

Request      

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

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

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

URL Parameters

query   string   

Example: id

countryCode   string  optional  

Example: aut

Search warehouses for NovaPoshtaGlobal by City.

requires authentication

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

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/express-orders/warehouses-by-city-for-npg/veritatis/odit" \
    --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": [
    [
      {
        "reference": "1ec09d6b-e1c2-11e3-8c4a-0050568002cf",
        "currentTranslate": {
            "name": "Kyiv, Kyivska, Viddilennia №7...",
            "city": "Kyiv, Kyivska"
          },
      },
      ...
    ]
  ]
}
 

Request      

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

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

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

URL Parameters

query   string   

Example: veritatis

countryCode   string  optional  

Example: odit

Display the specified order express resource.

requires authentication

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

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/express-orders/maiores" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: required   \'Basic \' + base64 encoded \'user_id:api_token\'"

Example response (200):


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

Request      

GET /api/express-orders/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

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

URL Parameters

id   string   

The ID of the express order. Example: maiores

orderExpressId   integer  optional  

Order Id. Example: 1

Get tracking history by order id.

requires authentication

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

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/express-orders/illum/tracking-history" \
    --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/express-orders/{id}/tracking-history

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

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

URL Parameters

id   string   

The ID of the express order. Example: illum

orderFbmId   integer  optional  

Order Id. Example: 20

Get Shipping Delivery Price from NPG Api.

requires authentication

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://system.skladusa.com/api/express-orders/npg-price';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'warehouse_id' => 16,
            'payment_transaction_id' => 8,
            'sender' => [
                'quia',
            ],
            'recipient' => [
                'exercitationem',
            ],
            'products' => [
                'velit',
            ],
            'proform_packaging' => [
                'a',
            ],
            'insurance_amount' => 'ut',
            'for_consolidation' => false,
            'order_express_id' => 10,
            'vat_number' => 'adipisci',
            'promocodes' => [
                [
                    'code' => 'vero',
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://system.skladusa.com/api/express-orders/npg-price"
);

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

let body = {
    "warehouse_id": 16,
    "payment_transaction_id": 8,
    "sender": [
        "quia"
    ],
    "recipient": [
        "exercitationem"
    ],
    "products": [
        "velit"
    ],
    "proform_packaging": [
        "a"
    ],
    "insurance_amount": "ut",
    "for_consolidation": false,
    "order_express_id": 10,
    "vat_number": "adipisci",
    "promocodes": [
        {
            "code": "vero"
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
curl --request POST \
    "https://system.skladusa.com/api/express-orders/npg-price" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"warehouse_id\": 16,
    \"payment_transaction_id\": 8,
    \"sender\": [
        \"quia\"
    ],
    \"recipient\": [
        \"exercitationem\"
    ],
    \"products\": [
        \"velit\"
    ],
    \"proform_packaging\": [
        \"a\"
    ],
    \"insurance_amount\": \"ut\",
    \"for_consolidation\": false,
    \"order_express_id\": 10,
    \"vat_number\": \"adipisci\",
    \"promocodes\": [
        {
            \"code\": \"vero\"
        }
    ]
}"

Example response (200):


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

Request      

POST /api/express-orders/npg-price

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

warehouse_id   integer  optional  

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

payment_transaction_id   integer  optional  

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

sender   string[]   

Order Express country_code,city,post_code

country_code   string   

Example: est

post_code   string   

Example: quia

city   string  optional  

Example: vel

region   string  optional  

Example: qui

address   string  optional  

Example: incidunt

additional_address   string  optional  

Example: corporis

recipient   string[]   

Order Express country_code,city,post_code

country_code   string   

Example: amet

post_code   string   

Example: delectus

city   string  optional  

Example: mollitia

region   string  optional  

Example: at

address   string  optional  

Example: explicabo

additional_address   string  optional  

Example: sunt

products   string[]   

Order Express product data

name   string   

Example: veniam

count   integer   

Example: 3

price   number   

Example: 12548.128211

proform_packaging   string[]   

Order Express proform packaging data

weight   number   

Must be at least 0. Example: 45

length   number   

Must be at least 0. Example: 18

width   number   

Example: 12

height   number   

Must be at least 0. Example: 90

packaging_type   string  optional  

Example: fedex_packaging

Must be one of:
  • himself_packaging
  • fedex_packaging
  • fedex_envelope_packaging
insurance_amount   numeric   

Order Express insurance_amount data Example: ut

for_consolidation   boolean  optional  

Example: false

promocodes   object[]  optional  

@var OrderExpress $orderExpressInstance.

code   string   

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

order_express_id   integer  optional  

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

vat_number   string  optional  

Example: adipisci

Creation label for express order.

requires authentication

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

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

let body = {
    "order_express_id": 8,
    "delivery_service_type": "wkh"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
curl --request POST \
    "https://system.skladusa.com/api/express-orders/make-label" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"order_express_id\": 8,
    \"delivery_service_type\": \"wkh\"
}"

Example response (200):


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

Request      

POST /api/express-orders/make-label

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

order_express_id   integer   

Order express id Example: 8

delivery_service_type   string  optional  

Must not be greater than 255 characters. Example: wkh

Get file by uuid.

requires authentication

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://system.skladusa.com/api/express-orders/get-file/2ae629ac-212a-30b8-932d-f3b6519ea0f2';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://system.skladusa.com/api/express-orders/get-file/2ae629ac-212a-30b8-932d-f3b6519ea0f2"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());
curl --request GET \
    --get "https://system.skladusa.com/api/express-orders/get-file/2ae629ac-212a-30b8-932d-f3b6519ea0f2" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response (200):


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

Request      

GET /api/express-orders/get-file/{uuid}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

uuid   string  optional  

required. uuid файла. Example: 2ae629ac-212a-30b8-932d-f3b6519ea0f2

Create new express order for NovaPoshtaGlobal.

requires authentication

Example request:
$client = new \GuzzleHttp\Client();
$url = 'https://system.skladusa.com/api/express-orders';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'Authorization' => 'required   \'Basic \' + base64 encoded \'user_id:api_token\'',
        ],
        'json' => [
            'total_order_amount' => 28244.4,
            'from_model' => 'from_order_external',
            'model_id' => 17,
            'delivery_service_id' => 2,
            'status' => 'completed',
            'send_type' => 'by_warehouse',
            'warehouse_id' => 5,
            'new_post_tracking_number' => 'vsk',
            'tracking_number' => 'odit',
            'sender_contact_name' => 'mnetoszkj',
            'sender_phone_number' => 'omnis',
            'recipient_contact_name' => 'pmfoqc',
            'recipient_phone_number' => '+ddext*s8{3,}$/im',
            'recipient_email' => '[email protected]',
            'recipient_address' => 'pwnrlavmukonlczen',
            'recipient_additional_address' => 'xauneqlb',
            'recipient_city' => 'kvbsnlcmfny',
            'recipient_region' => 'tbkcv',
            'recipient_country_id' => 16,
            'recipient_zip_code' => 'coralddzmdnmbhnjpzuzmuhpu',
            'recipient_currency_id' => 10,
            'delivery_date' => '3703-93-52$/i',
            'available_courier_time' => '44:54|26:33$/i',
            'not_available_courier_time' => '65:91|98:67$/i',
            'vat_number' => 'tkpjascxjcxkjtoubhkehyfl',
            'proform_data' => [
                [
                    'handmade' => '1',
                    'item_quantity' => 4315968.67,
                    'item_price' => 28.760691,
                    'hs_code' => 'aqwfxymkbigfpfh',
                    'label_full_name' => 'kiuvenctahzhzxvssnona',
                    'category_id' => 20,
                    'name_id' => 20,
                    'material_id' => 18,
                ],
            ],
            'proform_packaging' => [
                'package_name' => 'dotzdizwabszbhbqyumy',
                'weight' => 1352436.6903,
                'length' => 890586.3990769,
                'width' => 27.2,
                'height' => 39973.8,
            ],
            'insurance_amount' => 29.153,
            'packaging_type' => 'himself_packaging',
            'drop_certification' => true,
            'toxic_substance' => false,
            'freight_cost' => 200.303545594,
            'in_draft' => '1',
            'courier_arrival_date' => '1696-94-34$/i',
            'courier_from_to_time' => '92:09|57:70$/i',
            'courier_contact_name' => 'hscmlz',
            'courier_contact_phone' => 'wu',
            'sender_contact_address' => 'et',
            'alarm_status' => false,
            'delivery_service_type' => 'auxj',
            'recipient_tax_value' => 'sed',
            'deleted_proform_ids' => [
                'proform_data' => [
                    8,
                ],
            ],
            'promocodes' => [
                [
                    'code' => 'accusantium',
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://system.skladusa.com/api/express-orders"
);

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

let body = {
    "total_order_amount": 28244.4,
    "from_model": "from_order_external",
    "model_id": 17,
    "delivery_service_id": 2,
    "status": "completed",
    "send_type": "by_warehouse",
    "warehouse_id": 5,
    "new_post_tracking_number": "vsk",
    "tracking_number": "odit",
    "sender_contact_name": "mnetoszkj",
    "sender_phone_number": "omnis",
    "recipient_contact_name": "pmfoqc",
    "recipient_phone_number": "+ddext*s8{3,}$\/im",
    "recipient_email": "[email protected]",
    "recipient_address": "pwnrlavmukonlczen",
    "recipient_additional_address": "xauneqlb",
    "recipient_city": "kvbsnlcmfny",
    "recipient_region": "tbkcv",
    "recipient_country_id": 16,
    "recipient_zip_code": "coralddzmdnmbhnjpzuzmuhpu",
    "recipient_currency_id": 10,
    "delivery_date": "3703-93-52$\/i",
    "available_courier_time": "44:54|26:33$\/i",
    "not_available_courier_time": "65:91|98:67$\/i",
    "vat_number": "tkpjascxjcxkjtoubhkehyfl",
    "proform_data": [
        {
            "handmade": "1",
            "item_quantity": 4315968.67,
            "item_price": 28.760691,
            "hs_code": "aqwfxymkbigfpfh",
            "label_full_name": "kiuvenctahzhzxvssnona",
            "category_id": 20,
            "name_id": 20,
            "material_id": 18
        }
    ],
    "proform_packaging": {
        "package_name": "dotzdizwabszbhbqyumy",
        "weight": 1352436.6903,
        "length": 890586.3990769,
        "width": 27.2,
        "height": 39973.8
    },
    "insurance_amount": 29.153,
    "packaging_type": "himself_packaging",
    "drop_certification": true,
    "toxic_substance": false,
    "freight_cost": 200.303545594,
    "in_draft": "1",
    "courier_arrival_date": "1696-94-34$\/i",
    "courier_from_to_time": "92:09|57:70$\/i",
    "courier_contact_name": "hscmlz",
    "courier_contact_phone": "wu",
    "sender_contact_address": "et",
    "alarm_status": false,
    "delivery_service_type": "auxj",
    "recipient_tax_value": "sed",
    "deleted_proform_ids": {
        "proform_data": [
            8
        ]
    },
    "promocodes": [
        {
            "code": "accusantium"
        }
    ]
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
curl --request PUT \
    "https://system.skladusa.com/api/express-orders" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: required   \'Basic \' + base64 encoded \'user_id:api_token\'" \
    --data "{
    \"total_order_amount\": 28244.4,
    \"from_model\": \"from_order_external\",
    \"model_id\": 17,
    \"delivery_service_id\": 2,
    \"status\": \"completed\",
    \"send_type\": \"by_warehouse\",
    \"warehouse_id\": 5,
    \"new_post_tracking_number\": \"vsk\",
    \"tracking_number\": \"odit\",
    \"sender_contact_name\": \"mnetoszkj\",
    \"sender_phone_number\": \"omnis\",
    \"recipient_contact_name\": \"pmfoqc\",
    \"recipient_phone_number\": \"+ddext*s8{3,}$\\/im\",
    \"recipient_email\": \"[email protected]\",
    \"recipient_address\": \"pwnrlavmukonlczen\",
    \"recipient_additional_address\": \"xauneqlb\",
    \"recipient_city\": \"kvbsnlcmfny\",
    \"recipient_region\": \"tbkcv\",
    \"recipient_country_id\": 16,
    \"recipient_zip_code\": \"coralddzmdnmbhnjpzuzmuhpu\",
    \"recipient_currency_id\": 10,
    \"delivery_date\": \"3703-93-52$\\/i\",
    \"available_courier_time\": \"44:54|26:33$\\/i\",
    \"not_available_courier_time\": \"65:91|98:67$\\/i\",
    \"vat_number\": \"tkpjascxjcxkjtoubhkehyfl\",
    \"proform_data\": [
        {
            \"handmade\": \"1\",
            \"item_quantity\": 4315968.67,
            \"item_price\": 28.760691,
            \"hs_code\": \"aqwfxymkbigfpfh\",
            \"label_full_name\": \"kiuvenctahzhzxvssnona\",
            \"category_id\": 20,
            \"name_id\": 20,
            \"material_id\": 18
        }
    ],
    \"proform_packaging\": {
        \"package_name\": \"dotzdizwabszbhbqyumy\",
        \"weight\": 1352436.6903,
        \"length\": 890586.3990769,
        \"width\": 27.2,
        \"height\": 39973.8
    },
    \"insurance_amount\": 29.153,
    \"packaging_type\": \"himself_packaging\",
    \"drop_certification\": true,
    \"toxic_substance\": false,
    \"freight_cost\": 200.303545594,
    \"in_draft\": \"1\",
    \"courier_arrival_date\": \"1696-94-34$\\/i\",
    \"courier_from_to_time\": \"92:09|57:70$\\/i\",
    \"courier_contact_name\": \"hscmlz\",
    \"courier_contact_phone\": \"wu\",
    \"sender_contact_address\": \"et\",
    \"alarm_status\": false,
    \"delivery_service_type\": \"auxj\",
    \"recipient_tax_value\": \"sed\",
    \"deleted_proform_ids\": {
        \"proform_data\": [
            8
        ]
    },
    \"promocodes\": [
        {
            \"code\": \"accusantium\"
        }
    ]
}"

Example response (200):


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

Request      

PUT /api/express-orders

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

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

Body Parameters

total_order_amount   number  optional  

Example: 28244.4

from_model   string  optional  

Example: from_order_external

Must be one of:
  • from_order_external
  • from_payment_transaction
model_id   integer  optional  

Example: 17

delivery_service_id   integer   

Example: 2

status   string  optional  

Example: completed

Must be one of:
  • completed
  • in_progress
  • copy
  • wait_for_pay
  • wait_for_making_label
send_type   string   

Example: by_warehouse

Must be one of:
  • by_himself
  • by_warehouse
warehouse_id   integer  optional  

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

new_post_tracking_number   string  optional  

Must not be greater than 255 characters. Example: vsk

tracking_number   string  optional  

Example: odit

sender_contact_name   string  optional  

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

sender_phone_number   string  optional  

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

recipient_contact_name   string   

Must not be greater than 255 characters. Example: pmfoqc

recipient_phone_number   string   

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

recipient_email   string  optional  

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

recipient_address   string   

Must not be greater than 255 characters. Example: pwnrlavmukonlczen

recipient_additional_address   string  optional  

Must not be greater than 255 characters. Example: xauneqlb

recipient_city   string   

Must not be greater than 255 characters. Example: kvbsnlcmfny

recipient_region   string   

Must not be greater than 255 characters. Example: tbkcv

recipient_country_id   integer   

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

recipient_zip_code   string   

Must not be greater than 255 characters. Example: coralddzmdnmbhnjpzuzmuhpu

recipient_currency_id   integer  optional  

Example: 10

delivery_date   string   

Must match the regex /\d{4}-\d{2}-\d{2}$/i. Example: 3703-93-52$/i

available_courier_time   string  optional  

Must match the regex /\d{2}:\d{2}|\d{2}:\d{2}$/i. Example: 44:54|26:33$/i

not_available_courier_time   string  optional  

Must match the regex /\d{2}:\d{2}|\d{2}:\d{2}$/i. Example: 65:91|98:67$/i

vat_number   string  optional  

Must not be greater than 255 characters. Example: tkpjascxjcxkjtoubhkehyfl

deleted_proform_ids   object  optional  
proform_data   integer[]  optional  
proform_data   object[]   
handmade   integer   

Example: 1

Must be one of:
  • 0
  • 1
item_quantity   number  optional  

Example: 4315968.67

item_price   number  optional  

Example: 28.760691

hs_code   string  optional  

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

label_full_name   string  optional  

Must not be greater than 255 characters. Example: kiuvenctahzhzxvssnona

category_id   integer   

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

name_id   integer   

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

material_id   integer   

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

proform_packaging   object  optional  
package_name   string  optional  

Must not be greater than 255 characters. Example: dotzdizwabszbhbqyumy

weight   number   

Example: 1352436.6903

length   number   

Example: 890586.3990769

width   number   

Example: 27.2

height   number   

Example: 39973.8

insurance_amount   number  optional  

Example: 29.153

packaging_type   string  optional  

Example: himself_packaging

Must be one of:
  • himself_packaging
  • fedex_packaging
  • fedex_envelope_packaging
drop_certification   boolean  optional  

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

toxic_substance   boolean  optional  

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

freight_cost   number  optional  

Example: 200.303545594

in_draft   integer  optional  

Example: 1

Must be one of:
  • 0
  • 1
courier_arrival_date   string  optional  

Must match the regex /\d{4}-\d{2}-\d{2}$/i. Example: 1696-94-34$/i

courier_from_to_time   string  optional  

Must match the regex /\d{2}:\d{2}|\d{2}:\d{2}$/i. Example: 92:09|57:70$/i

courier_contact_name   string  optional  

Must not be greater than 255 characters. Example: hscmlz

courier_contact_phone   string  optional  

Must not be greater than 255 characters. Example: wu

sender_contact_address   string  optional  

Example: et

alarm_status   boolean  optional  

Example: false

order_express_country_type   string  optional  
delivery_service_type   string  optional  

Must not be greater than 255 characters. Example: auxj

npg   object  optional  
address_type   string  optional  
ref_warehouse   string  optional  
warehouse_name   string  optional  
city_name   string  optional  
recipient_tax_value   string  optional  

Example: sed

promocodes   object[]  optional  
code   string   

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

Display a listing of the order express.

requires authentication

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

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": "required    '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/express-orders" \
    --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": 3666,
        ...
      },
      ...
    ],
    "pagination": {
      "last": 2,
      "current": 0,
      "numItemsPerPage": 10,
      "first": 1,
      "pageCount": 2,
      "totalCount": 19,
      "pageRange": 2,
      "startPage": 1,
      "endPage": 2,
      "previous": 0,
      "next": 1,
      "pagesInRange": [
          1,
          2
      ],
      "firstPageInRange": 1,
      "lastPageInRange": 2,
      "currentItemCount": 10,
      "firstItemNumber": 11,
      "lastItemNumber": 2
    },
  },
 "status": "success"
}
 

Request      

GET /api/express-orders

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

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

URL Parameters

page   integer  optional  

Current page default 1. Example: 16

limit   integer  optional  

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

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' => 'quis',
            'shopName' => 'earum',
            'orderId' => 'ratione',
            'iframeUrl' => 'https://www.gutkowski.com/esse-dolores-eos-molestias-omnis-earum',
            'callBackUrl' => 'http://kozey.com/distinctio-tempore-sequi-veniam-voluptatibus-quidem-voluptates.html',
        ],
    ]
);
$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": "quis",
    "shopName": "earum",
    "orderId": "ratione",
    "iframeUrl": "https:\/\/www.gutkowski.com\/esse-dolores-eos-molestias-omnis-earum",
    "callBackUrl": "http:\/\/kozey.com\/distinctio-tempore-sequi-veniam-voluptatibus-quidem-voluptates.html"
};

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\": \"quis\",
    \"shopName\": \"earum\",
    \"orderId\": \"ratione\",
    \"iframeUrl\": \"https:\\/\\/www.gutkowski.com\\/esse-dolores-eos-molestias-omnis-earum\",
    \"callBackUrl\": \"http:\\/\\/kozey.com\\/distinctio-tempore-sequi-veniam-voluptatibus-quidem-voluptates.html\"
}"

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

shopName   required  optional  

string Shop name Example: earum

orderId   required  optional  

string Order Id Example: ratione

iframeUrl   required  optional  

string iframe Url for authorize.net Example: https://www.gutkowski.com/esse-dolores-eos-molestias-omnis-earum

callBackUrl   required  optional  

string callBackUrl Url for site Example: http://kozey.com/distinctio-tempore-sequi-veniam-voluptatibus-quidem-voluptates.html

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' => 'dolor',
            'receiverZip' => 'culpa',
            'consolidationOrder' => 'dolorem',
            'skladCreateLabel' => 'sint',
        ],
    ]
);
$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": "dolor",
    "receiverZip": "culpa",
    "consolidationOrder": "dolorem",
    "skladCreateLabel": "sint"
};

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\": \"dolor\",
    \"receiverZip\": \"culpa\",
    \"consolidationOrder\": \"dolorem\",
    \"skladCreateLabel\": \"sint\"
}"

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

receiverZip   required  optional  

string Receiver zip number Example: culpa

consolidationOrder   required  optional  

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

skladCreateLabel   required  optional  

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

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

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' => 'necessitatibus',
            'lastName' => 'illum',
            'companyName' => 'ipsa',
        ],
    ]
);
$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": "necessitatibus",
    "lastName": "illum",
    "companyName": "ipsa"
};

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\": \"necessitatibus\",
    \"lastName\": \"illum\",
    \"companyName\": \"ipsa\"
}"

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

lastName   required  optional  

string Receiver company name Example: illum

companyName   required  optional  

string Receiver email Example: ipsa