MENU navbar-image

Introduction

Welcome to our API documentation!

Base URL

https://system.skladusa.com

Authenticating requests

This API is not authenticated.

Authorize Pay

Get Authorize popup HTML

requires authentication

Example request:
$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://system.skladusa.com/api/gateway',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'Authorization' => 'required   Basic + base64 encoded \'user_id:api_token\'',
        ],
        'json' => [
            'sum' => 1344725.16081,
            'orderId' => 'fugit',
            'iframeUrl' => 'nemo',
            'callBackUrl' => 'sed',
        ],
    ]
);
$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": 1344725.16081,
    "orderId": "fugit",
    "iframeUrl": "nemo",
    "callBackUrl": "sed"
};

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\": 1344725.16081,
    \"orderId\": \"fugit\",
    \"iframeUrl\": \"nemo\",
    \"callBackUrl\": \"sed\"
}"

Example response (200):

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

Request      

POST /api/gateway

Body Parameters

sum  number  

orderId  string  

iframeUrl  string  

callBackUrl  string  

Key Crm

Get Rate List for Key Crm

requires authentication

Example request:
$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://system.skladusa.com/api/key-crm/rate/list',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'Authorization' => 'required    Basic + base64 encoded \'user_id:api_token\'',
        ],
        'json' => [
            'senderCountryCode' => 'est',
            'length' => 3011.029034484,
            'height' => 1.27,
            'width' => 2065910.8261,
            'weight' => 8.1669,
            'countryCode' => 'reiciendis',
            'stateCode' => 'consequatur',
            'zipCode' => 'quis',
            'city' => 'eos',
            'clientPayPal' => true,
        ],
    ]
);
$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": "est",
    "length": 3011.029034484,
    "height": 1.27,
    "width": 2065910.8261,
    "weight": 8.1669,
    "countryCode": "reiciendis",
    "stateCode": "consequatur",
    "zipCode": "quis",
    "city": "eos",
    "clientPayPal": true
};

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\": \"est\",
    \"length\": 3011.029034484,
    \"height\": 1.27,
    \"width\": 2065910.8261,
    \"weight\": 8.1669,
    \"countryCode\": \"reiciendis\",
    \"stateCode\": \"consequatur\",
    \"zipCode\": \"quis\",
    \"city\": \"eos\",
    \"clientPayPal\": true
}"

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

Body Parameters

senderCountryCode  string  

Must be one of ua, lv, pl, or us.

length  number  

height  number  

width  number  

weight  number  

countryCode  string  

stateCode  string optional  

zipCode  string  

city  string  

clientPayPal  boolean  

Prepare order data for Key Crm.

requires authentication

Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://system.skladusa.com/api/key-crm/create-order',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'Authorization' => 'required    Basic + base64 encoded \'user_id:api_token\'',
        ],
        'json' => [
            'orderType' => 'self:create',
            'transaction' => 'et',
            'etsy' => 'aut',
        ],
    ]
);
$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'",
};

let body = {
    "orderType": "self:create",
    "transaction": "et",
    "etsy": "aut"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).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\'" \
    --data "{
    \"orderType\": \"self:create\",
    \"transaction\": \"et\",
    \"etsy\": \"aut\"
}"

Example response (200):

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

Request      

GET /api/key-crm/create-order

URL Parameters

orderType  string optional  

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

transaction  string optional  

transaction number.

etsy  string optional  

etsy order id.

Body Parameters

orderType  string optional  

Must be one of consolidation, self:create, or sklad:create.

transaction  string optional  

etsy  string optional  

Orders FBM

Display a listing of the order fbm data.

requires authentication

Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://system.skladusa.com/api/order',
    [
        '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",
     "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",
     "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
         }
      ]
    }
 }
 ............
 ]
}
],
"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

URL Parameters

page  integer optional  

Current page default 1.

numItemsPerPage  integer optional  

Num Items Per Page by default 20 max per page 100

Display example of the order fbm body response.

requires authentication

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

Display a listing of the shipping methods.

requires authentication

Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://system.skladusa.com/api/shipping-method',
    [
        '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

Display the delivery methods for order fbm resource.

requires authentication

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

URL Parameters

id  string  

The ID of the order.

orderFbmId  integer optional  

Order Id.

Display a listing of the packing types.

requires authentication

Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://system.skladusa.com/api/user-pack-type',
    [
        '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

Get packing type price list for order.

requires authentication

Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://system.skladusa.com/api/packaging-type',
    [
        '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

Display the specified order fbm resource.

requires authentication

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

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/nobis" \
    --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",
     "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",
     "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
         }
      ]
    }
 }
 "status": "success"
}
 

Request      

GET /api/order/{id}

URL Parameters

id  string  

The ID of the order.

orderFbmId  integer optional  

Order Id.

Get tracking history by order id.

requires authentication

Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://system.skladusa.com/api/order/dignissimos/track',
    [
        '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/dignissimos/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/dignissimos/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

URL Parameters

id  string  

The ID of the order.

orderFbmId  integer optional  

Order Id.

Get Rate List for Order FBM

requires authentication

Example request:
$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://system.skladusa.com/api/rate/list',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'Authorization' => 'required    Basic + base64 encoded \'user_id:api_token\'',
        ],
        'json' => [
            'senderCountryCode' => 'vitae',
            'length' => 3.3,
            'height' => 750.0,
            'width' => 2522.05333,
            'weight' => 5638578.0,
            'countryCode' => 'sint',
            'stateCode' => 'et',
            'zipCode' => 'aut',
            'city' => 'ipsum',
            'clientPayPal' => true,
        ],
    ]
);
$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": "vitae",
    "length": 3.3,
    "height": 750,
    "width": 2522.05333,
    "weight": 5638578,
    "countryCode": "sint",
    "stateCode": "et",
    "zipCode": "aut",
    "city": "ipsum",
    "clientPayPal": true
};

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\": \"vitae\",
    \"length\": 3.3,
    \"height\": 750,
    \"width\": 2522.05333,
    \"weight\": 5638578,
    \"countryCode\": \"sint\",
    \"stateCode\": \"et\",
    \"zipCode\": \"aut\",
    \"city\": \"ipsum\",
    \"clientPayPal\": true
}"

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

Body Parameters

senderCountryCode  string  

Must be one of ua, lv, pl, or us.

length  number  

height  number  

width  number  

weight  number  

countryCode  string  

stateCode  string optional  

zipCode  string  

city  string  

clientPayPal  boolean  

Make label for order FBM

requires authentication

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

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

let body = {
    "serviceId": "RLGCE:UMdbOkaH:lljWgAV$\/i"
};

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

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

URL Parameters

id  string  

The ID of the order.

orderFbmId  integer optional  

Order Id.

Body Parameters

serviceId  string  

The value format is invalid.

Store the specified order fbm resource.

requires authentication

Example request:
$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://system.skladusa.com/api/order',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'Authorization' => 'required    Basic + base64 encoded \'user_id:api_token\'',
        ],
        'json' => [
            'receiverName' => 'retfwgzluqrstojqjcihmvsqjdzvddlxhgpqreqkceetmbwvfewbrjfotolosygbqyxfmxdmhvchoyrygpbpphdpylgrvucmgxgyajqdwpkbeafkqhbgwleqclmhiqkwcefdopvrhtqclphkryvmzowkxawwuxjfzodvhogckghokqiblsbqxnsavefspzszlwos',
            'receiverEmail' => 'fqfcslfqinrikcuptoondktzrrqwze',
            'receiverPhone' => 'ciwxnqlzqveqghvkwbrwmoauhjzbpbrvabivdkerkkgumhvhkzridpvrchdxzyiuawmqeucufdfsjbzbkswoxqlsgiqqyagoicmdlgzybawswntinpdldlhzvsoonqvnwdevplqosnjvvsqwszhqfevpuaheitjqhyoablzmtsrklylheosnjelyhyuwyvvxmanusmhygrlvhwslondkkgebrcdwhfprkgvicflogllcwyv',
            'receiverAddress' => 'r',
            'receiverCity' => 'zjjcmddykqqwpfpfjtcdjtpsdoqchinymyfjtzqtydyxjhkugxlwymcthiiocwmkeghiwto',
            'receiverZip' => 'tgwyitotloqqwgslzvrxhnlpwdjungdfzxnofrmqtdvkazwadgzvkmicnehsqcmujhytnfcpleqtwrfthhrzogaepbtspbcsxrkoomohjbssqrxyeygcym',
            'receiverState' => 'juwqlipfhpkiiudcwacvsoonnponqespcofghgzkcwruzsbuuydngabaymuldpuwatmxxemobcyadhtlhksiiksanehroydsnvhhzgrjyfeerziznjenverlwyklnvoyulmprppeimhluxleespwtcxsiyvmqlnrjxapyaw',
            'receiverCountry' => 'f',
            'weightLb' => 4.96160405,
            'weightOz' => 1403.551,
            'length' => 0.0,
            'width' => 4355652.2995,
            'height' => 368.4,
            'comment' => 'ipvznixuphylgmihlviqipzgvfvtszydymsatoptmrwxempzcmhfczjryzhidyjylfmszkwtvlqdmhfdjcieewcjitdqgcfftzmfbyqjrttrcqbjflkpweplebrbmkfdhbleizzqnnilcewyywutmtlzmhuymfpspesgwbhnoeeujxrphpeavzbalgjzomlxxrfbwxezjcfdvdnawdtzblunkltrxreadgxeytrtutyhduhvbhlrgkafalopiqqsglstlowwabycfoocfzqqsbgfrsakwxfisvbcyjyzjgscxqhcmfgwphorlrutgexmgptefjidxfohjxbzwjzybczfmmyptsxktfheqkyjzcpqlxyrjbwqbdkydatnuidkxwsgsvcduuknbgzlwwclkegnjejvaxvbwhtziezinorzozkksvxnbfzlwdyxnzubrpgfcbfmvjxbsqnezdipxoeondcrstmfnxrfyvmkevvbqlxfwfrinqfyqbjwexcfyfapbztasahptreerjrvknqpsmsopinzjxtmvbleukkmwmmvsdwnbmngvflmrrreuuewsbhzqdxsnmxhuewqbstimcebhfqdnwaqaxrqmxlpqqezwyxcjujvbtvukiimtfuegutptmjppxruxpdgadxfcxpgzmsknyirmkldjzpqdmngvbggfontfyxietggnrcrfhhhieyqibotiycbwfmppwmzzkokjdhqgambvjzijmakibnnzxdwdcfvgckcjiasukbdqmhewibbwgsjiwhmztwyzttctvdgklchqpgkhypeepxzozuvnevgndzqbclngvwstygpaddujsqiwmmvepupgasmgbqvezhpsazakshdeiuyhevrssnlqkxkowxhxfoanvdmkkbjfzqmwoghwfudotqsdgivuvoentwdfooajvyjdhubepkxlrzoczqoavktlgvuvekrcnbtiscrvpicbjtfxjvwahuxcunzodyujvtztkezjcyecotrlvqarabldrulndfnliowsnvqxgljytynaqmartziwfocmkwrwzabwwkyeqgjpthtpbqinpfqprefkclneojysxygofuafxmfrofhpbeklxcfjhldjqdkygqtjdvulaxwakmwrzihadhtzckjpuhbnmdoorbcajalrgwtqvnwpbzeametmtztfyrurmgevgvtswjkffudegpqgjbytlmmdlgexzhivdupdtgmybsepulsldeobofmukncqyetjkrpthrnwtjqnopetqfwmmrfcmfaazxvatoisipjqjfpebihchddtiryhzkawewrfzvizgmwcfmeobhtdnhzvedndjpuvslocpmyihtuuyylbkcojudkppzdpnqvtchvhjpyzlxwwnioqlqnayrcsefwexyvfekfchjekpyoteszozayfyzvhxjbpvlwpiexsvdcotagopjldwjyduagofxlorhrmqdehifmhkmiftkrsgfnpcbqrutvcegeinrthhyrdvdupgkejzkkfdoefqzzrqgtutdmerqzgygphrrbhzuwjxxydbhnqmajinovqgtsszgcxxaazwtiecusvwevpldmoqvutlpfwngotzumpxkvaqtqcxhuhheqamekavhmfscnnfgzprvsgtkrdznxjraljwxwyxrbpfbichxrugladfpuaawexghrkazlqdpoqwhytpqgwsirqcokwjhwknljtdmlbatdrpcjqeiknscdsjbmjnfqhmpxtumzzhyylavmkyfxlqgomwigvqzdwmlqibkpetikcbunpnhueoqxuphdgxfbfpeiphevaurbctpwykvlcpdtwhzfqqlypjsrcgehjizvaexdzguoqchfyusskkfvmstayvvqfnxpnsiyysyuzsrtvqmwhpzfwyplkzfdecpvqeiohrjpizborskdyujevwfarlvezvlhflaehksxfaahodgrtxluwznnmvlvcxuqozmzrbvgsvswydjolpygbxosukewmdjahlqjtqvgei',
            'vatTaxId' => 'jfnjtophzqeyl',
            'insurancesStatus' => false,
            'insurances' => 274910703.45479786,
            'externalId' => 'id',
            'apiShipMethod' => '6{1,}_4{1,}$/i',
            'packagingId' => 'aut',
            'consolidationOrder' => 'voluptates',
            'skladCreateLabel' => 'dolore',
            'userPackType' => 'eveniet',
            'productsConsolidationData' => [
                [
                    'id' => 1,
                    'categoryId' => 8,
                    'descrEn' => 'tempore',
                    'nameId' => 18,
                    'forSelectedId' => 1,
                    'materialId' => 7,
                    'subMaterialId' => 16,
                    'hsCode' => 'adipisci',
                    'price' => 15.03,
                    'count' => 1,
                ],
            ],
            'productsData' => [
                [
                    'product' => 13,
                    'hsCode' => 'id',
                    'count' => 1,
                ],
            ],
        ],
    ]
);
$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": "retfwgzluqrstojqjcihmvsqjdzvddlxhgpqreqkceetmbwvfewbrjfotolosygbqyxfmxdmhvchoyrygpbpphdpylgrvucmgxgyajqdwpkbeafkqhbgwleqclmhiqkwcefdopvrhtqclphkryvmzowkxawwuxjfzodvhogckghokqiblsbqxnsavefspzszlwos",
    "receiverEmail": "fqfcslfqinrikcuptoondktzrrqwze",
    "receiverPhone": "ciwxnqlzqveqghvkwbrwmoauhjzbpbrvabivdkerkkgumhvhkzridpvrchdxzyiuawmqeucufdfsjbzbkswoxqlsgiqqyagoicmdlgzybawswntinpdldlhzvsoonqvnwdevplqosnjvvsqwszhqfevpuaheitjqhyoablzmtsrklylheosnjelyhyuwyvvxmanusmhygrlvhwslondkkgebrcdwhfprkgvicflogllcwyv",
    "receiverAddress": "r",
    "receiverCity": "zjjcmddykqqwpfpfjtcdjtpsdoqchinymyfjtzqtydyxjhkugxlwymcthiiocwmkeghiwto",
    "receiverZip": "tgwyitotloqqwgslzvrxhnlpwdjungdfzxnofrmqtdvkazwadgzvkmicnehsqcmujhytnfcpleqtwrfthhrzogaepbtspbcsxrkoomohjbssqrxyeygcym",
    "receiverState": "juwqlipfhpkiiudcwacvsoonnponqespcofghgzkcwruzsbuuydngabaymuldpuwatmxxemobcyadhtlhksiiksanehroydsnvhhzgrjyfeerziznjenverlwyklnvoyulmprppeimhluxleespwtcxsiyvmqlnrjxapyaw",
    "receiverCountry": "f",
    "weightLb": 4.96160405,
    "weightOz": 1403.551,
    "length": 0,
    "width": 4355652.2995,
    "height": 368.4,
    "comment": "ipvznixuphylgmihlviqipzgvfvtszydymsatoptmrwxempzcmhfczjryzhidyjylfmszkwtvlqdmhfdjcieewcjitdqgcfftzmfbyqjrttrcqbjflkpweplebrbmkfdhbleizzqnnilcewyywutmtlzmhuymfpspesgwbhnoeeujxrphpeavzbalgjzomlxxrfbwxezjcfdvdnawdtzblunkltrxreadgxeytrtutyhduhvbhlrgkafalopiqqsglstlowwabycfoocfzqqsbgfrsakwxfisvbcyjyzjgscxqhcmfgwphorlrutgexmgptefjidxfohjxbzwjzybczfmmyptsxktfheqkyjzcpqlxyrjbwqbdkydatnuidkxwsgsvcduuknbgzlwwclkegnjejvaxvbwhtziezinorzozkksvxnbfzlwdyxnzubrpgfcbfmvjxbsqnezdipxoeondcrstmfnxrfyvmkevvbqlxfwfrinqfyqbjwexcfyfapbztasahptreerjrvknqpsmsopinzjxtmvbleukkmwmmvsdwnbmngvflmrrreuuewsbhzqdxsnmxhuewqbstimcebhfqdnwaqaxrqmxlpqqezwyxcjujvbtvukiimtfuegutptmjppxruxpdgadxfcxpgzmsknyirmkldjzpqdmngvbggfontfyxietggnrcrfhhhieyqibotiycbwfmppwmzzkokjdhqgambvjzijmakibnnzxdwdcfvgckcjiasukbdqmhewibbwgsjiwhmztwyzttctvdgklchqpgkhypeepxzozuvnevgndzqbclngvwstygpaddujsqiwmmvepupgasmgbqvezhpsazakshdeiuyhevrssnlqkxkowxhxfoanvdmkkbjfzqmwoghwfudotqsdgivuvoentwdfooajvyjdhubepkxlrzoczqoavktlgvuvekrcnbtiscrvpicbjtfxjvwahuxcunzodyujvtztkezjcyecotrlvqarabldrulndfnliowsnvqxgljytynaqmartziwfocmkwrwzabwwkyeqgjpthtpbqinpfqprefkclneojysxygofuafxmfrofhpbeklxcfjhldjqdkygqtjdvulaxwakmwrzihadhtzckjpuhbnmdoorbcajalrgwtqvnwpbzeametmtztfyrurmgevgvtswjkffudegpqgjbytlmmdlgexzhivdupdtgmybsepulsldeobofmukncqyetjkrpthrnwtjqnopetqfwmmrfcmfaazxvatoisipjqjfpebihchddtiryhzkawewrfzvizgmwcfmeobhtdnhzvedndjpuvslocpmyihtuuyylbkcojudkppzdpnqvtchvhjpyzlxwwnioqlqnayrcsefwexyvfekfchjekpyoteszozayfyzvhxjbpvlwpiexsvdcotagopjldwjyduagofxlorhrmqdehifmhkmiftkrsgfnpcbqrutvcegeinrthhyrdvdupgkejzkkfdoefqzzrqgtutdmerqzgygphrrbhzuwjxxydbhnqmajinovqgtsszgcxxaazwtiecusvwevpldmoqvutlpfwngotzumpxkvaqtqcxhuhheqamekavhmfscnnfgzprvsgtkrdznxjraljwxwyxrbpfbichxrugladfpuaawexghrkazlqdpoqwhytpqgwsirqcokwjhwknljtdmlbatdrpcjqeiknscdsjbmjnfqhmpxtumzzhyylavmkyfxlqgomwigvqzdwmlqibkpetikcbunpnhueoqxuphdgxfbfpeiphevaurbctpwykvlcpdtwhzfqqlypjsrcgehjizvaexdzguoqchfyusskkfvmstayvvqfnxpnsiyysyuzsrtvqmwhpzfwyplkzfdecpvqeiohrjpizborskdyujevwfarlvezvlhflaehksxfaahodgrtxluwznnmvlvcxuqozmzrbvgsvswydjolpygbxosukewmdjahlqjtqvgei",
    "vatTaxId": "jfnjtophzqeyl",
    "insurancesStatus": false,
    "insurances": 274910703.45479786,
    "externalId": "id",
    "apiShipMethod": "6{1,}_4{1,}$\/i",
    "packagingId": "aut",
    "consolidationOrder": "voluptates",
    "skladCreateLabel": "dolore",
    "userPackType": "eveniet",
    "productsConsolidationData": [
        {
            "id": 1,
            "categoryId": 8,
            "descrEn": "tempore",
            "nameId": 18,
            "forSelectedId": 1,
            "materialId": 7,
            "subMaterialId": 16,
            "hsCode": "adipisci",
            "price": 15.03,
            "count": 1
        }
    ],
    "productsData": [
        {
            "product": 13,
            "hsCode": "id",
            "count": 1
        }
    ]
};

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\": \"retfwgzluqrstojqjcihmvsqjdzvddlxhgpqreqkceetmbwvfewbrjfotolosygbqyxfmxdmhvchoyrygpbpphdpylgrvucmgxgyajqdwpkbeafkqhbgwleqclmhiqkwcefdopvrhtqclphkryvmzowkxawwuxjfzodvhogckghokqiblsbqxnsavefspzszlwos\",
    \"receiverEmail\": \"fqfcslfqinrikcuptoondktzrrqwze\",
    \"receiverPhone\": \"ciwxnqlzqveqghvkwbrwmoauhjzbpbrvabivdkerkkgumhvhkzridpvrchdxzyiuawmqeucufdfsjbzbkswoxqlsgiqqyagoicmdlgzybawswntinpdldlhzvsoonqvnwdevplqosnjvvsqwszhqfevpuaheitjqhyoablzmtsrklylheosnjelyhyuwyvvxmanusmhygrlvhwslondkkgebrcdwhfprkgvicflogllcwyv\",
    \"receiverAddress\": \"r\",
    \"receiverCity\": \"zjjcmddykqqwpfpfjtcdjtpsdoqchinymyfjtzqtydyxjhkugxlwymcthiiocwmkeghiwto\",
    \"receiverZip\": \"tgwyitotloqqwgslzvrxhnlpwdjungdfzxnofrmqtdvkazwadgzvkmicnehsqcmujhytnfcpleqtwrfthhrzogaepbtspbcsxrkoomohjbssqrxyeygcym\",
    \"receiverState\": \"juwqlipfhpkiiudcwacvsoonnponqespcofghgzkcwruzsbuuydngabaymuldpuwatmxxemobcyadhtlhksiiksanehroydsnvhhzgrjyfeerziznjenverlwyklnvoyulmprppeimhluxleespwtcxsiyvmqlnrjxapyaw\",
    \"receiverCountry\": \"f\",
    \"weightLb\": 4.96160405,
    \"weightOz\": 1403.551,
    \"length\": 0,
    \"width\": 4355652.2995,
    \"height\": 368.4,
    \"comment\": \"ipvznixuphylgmihlviqipzgvfvtszydymsatoptmrwxempzcmhfczjryzhidyjylfmszkwtvlqdmhfdjcieewcjitdqgcfftzmfbyqjrttrcqbjflkpweplebrbmkfdhbleizzqnnilcewyywutmtlzmhuymfpspesgwbhnoeeujxrphpeavzbalgjzomlxxrfbwxezjcfdvdnawdtzblunkltrxreadgxeytrtutyhduhvbhlrgkafalopiqqsglstlowwabycfoocfzqqsbgfrsakwxfisvbcyjyzjgscxqhcmfgwphorlrutgexmgptefjidxfohjxbzwjzybczfmmyptsxktfheqkyjzcpqlxyrjbwqbdkydatnuidkxwsgsvcduuknbgzlwwclkegnjejvaxvbwhtziezinorzozkksvxnbfzlwdyxnzubrpgfcbfmvjxbsqnezdipxoeondcrstmfnxrfyvmkevvbqlxfwfrinqfyqbjwexcfyfapbztasahptreerjrvknqpsmsopinzjxtmvbleukkmwmmvsdwnbmngvflmrrreuuewsbhzqdxsnmxhuewqbstimcebhfqdnwaqaxrqmxlpqqezwyxcjujvbtvukiimtfuegutptmjppxruxpdgadxfcxpgzmsknyirmkldjzpqdmngvbggfontfyxietggnrcrfhhhieyqibotiycbwfmppwmzzkokjdhqgambvjzijmakibnnzxdwdcfvgckcjiasukbdqmhewibbwgsjiwhmztwyzttctvdgklchqpgkhypeepxzozuvnevgndzqbclngvwstygpaddujsqiwmmvepupgasmgbqvezhpsazakshdeiuyhevrssnlqkxkowxhxfoanvdmkkbjfzqmwoghwfudotqsdgivuvoentwdfooajvyjdhubepkxlrzoczqoavktlgvuvekrcnbtiscrvpicbjtfxjvwahuxcunzodyujvtztkezjcyecotrlvqarabldrulndfnliowsnvqxgljytynaqmartziwfocmkwrwzabwwkyeqgjpthtpbqinpfqprefkclneojysxygofuafxmfrofhpbeklxcfjhldjqdkygqtjdvulaxwakmwrzihadhtzckjpuhbnmdoorbcajalrgwtqvnwpbzeametmtztfyrurmgevgvtswjkffudegpqgjbytlmmdlgexzhivdupdtgmybsepulsldeobofmukncqyetjkrpthrnwtjqnopetqfwmmrfcmfaazxvatoisipjqjfpebihchddtiryhzkawewrfzvizgmwcfmeobhtdnhzvedndjpuvslocpmyihtuuyylbkcojudkppzdpnqvtchvhjpyzlxwwnioqlqnayrcsefwexyvfekfchjekpyoteszozayfyzvhxjbpvlwpiexsvdcotagopjldwjyduagofxlorhrmqdehifmhkmiftkrsgfnpcbqrutvcegeinrthhyrdvdupgkejzkkfdoefqzzrqgtutdmerqzgygphrrbhzuwjxxydbhnqmajinovqgtsszgcxxaazwtiecusvwevpldmoqvutlpfwngotzumpxkvaqtqcxhuhheqamekavhmfscnnfgzprvsgtkrdznxjraljwxwyxrbpfbichxrugladfpuaawexghrkazlqdpoqwhytpqgwsirqcokwjhwknljtdmlbatdrpcjqeiknscdsjbmjnfqhmpxtumzzhyylavmkyfxlqgomwigvqzdwmlqibkpetikcbunpnhueoqxuphdgxfbfpeiphevaurbctpwykvlcpdtwhzfqqlypjsrcgehjizvaexdzguoqchfyusskkfvmstayvvqfnxpnsiyysyuzsrtvqmwhpzfwyplkzfdecpvqeiohrjpizborskdyujevwfarlvezvlhflaehksxfaahodgrtxluwznnmvlvcxuqozmzrbvgsvswydjolpygbxosukewmdjahlqjtqvgei\",
    \"vatTaxId\": \"jfnjtophzqeyl\",
    \"insurancesStatus\": false,
    \"insurances\": 274910703.45479786,
    \"externalId\": \"id\",
    \"apiShipMethod\": \"6{1,}_4{1,}$\\/i\",
    \"packagingId\": \"aut\",
    \"consolidationOrder\": \"voluptates\",
    \"skladCreateLabel\": \"dolore\",
    \"userPackType\": \"eveniet\",
    \"productsConsolidationData\": [
        {
            \"id\": 1,
            \"categoryId\": 8,
            \"descrEn\": \"tempore\",
            \"nameId\": 18,
            \"forSelectedId\": 1,
            \"materialId\": 7,
            \"subMaterialId\": 16,
            \"hsCode\": \"adipisci\",
            \"price\": 15.03,
            \"count\": 1
        }
    ],
    \"productsData\": [
        {
            \"product\": 13,
            \"hsCode\": \"id\",
            \"count\": 1
        }
    ]
}"

Example response (200):

{
"data": [
 {
 "order": {
     "id": 143,
     "receiverName": "receiverName",
     "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",
     "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
         }
      ]
    }
 },
     "status": "success"
}
 

Request      

PUT /api/order

Body Parameters

receiverName  string  

Must not be greater than 255 characters.

receiverEmail  string  

Must be a valid email address. Must not be greater than 255 characters.

receiverPhone  string optional  

Must not be greater than 255 characters.

receiverAddress  string  

Must not be greater than 35 characters.

receiverCity  string  

Must not be greater than 255 characters.

receiverZip  string  

Must not be greater than 255 characters.

receiverState  string  

Must not be greater than 255 characters.

receiverCountry  string  

Must not be greater than 2 characters.

weightLb  number optional  

weightOz  number optional  

length  number optional  

width  number optional  

height  number optional  

comment  string optional  

Must not be greater than 5000 characters.

vatTaxId  string optional  

Must not be greater than 35 characters.

insurancesStatus  boolean optional  

insurances  number optional  

externalId  string optional  

apiShipMethod  string optional  

The value format is invalid.

packagingId  string optional  

consolidationOrder  string  

skladCreateLabel  string  

userPackType  string optional  

productsConsolidationData  object[] optional  

productsConsolidationData[].id  integer optional  

productsConsolidationData[].categoryId  integer optional  

productsConsolidationData[].descrEn  string optional  

productsConsolidationData[].nameId  integer optional  

productsConsolidationData[].forSelectedId  integer optional  

productsConsolidationData[].materialId  integer optional  

productsConsolidationData[].subMaterialId  integer optional  

productsConsolidationData[].hsCode  string optional  

productsConsolidationData[].price  number  

productsConsolidationData[].count  integer  

Must be at least 1.

productsData  object[] optional  

productsData[].product  integer  

productsData[].hsCode  string optional  

productsData[].count  integer  

Must be at least 1.

Update the specified order fbm resource.

requires authentication

Example request:
$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://system.skladusa.com/api/order/voluptatem',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'Authorization' => 'required    Basic + base64 encoded \'user_id:api_token\'',
        ],
        'json' => [
            'receiverName' => 'hqzntuljcdpgkzhzninicgptspuzhoxexgsvahfiscpzztbnqzzmmxxqcjqokslebjivsjszqjqppfb',
            'receiverEmail' => 'ywydaajuxowvoprurtmqhvavflywjnibzcjcjonsepuhxwsrcvfjtnfbngeehkkkvjrbepaifpimigzmcawjdhabpccprcvdefpuflzyqxujgklfrnfitstyooqfpcygbjfhpcmksciadtlgpgdeaaeneojtjewzenvwcrbjlllseywixrwwjqeniiawjftyljqpahkxedeezfltorfyzwjqphicpwatyiiuza',
            'receiverPhone' => 'jpiidlvgyxntcyivgmppskvdbwmabrgywncqjosmdxwkcwtiiidmaczkglwhhfbioygmroquagedvuoneeqrxiifjtijnwjgnkrkughjsvmtdgrkjwylfqwfxndbetqbqppuixjuyurzuexilrjkdpkagvcucohnlcgofnurhgadfwgraei',
            'receiverAddress' => 'hpnxsrxonrnckehxfrwkqutheo',
            'receiverCity' => 'gdqvufunfartorrwqby',
            'receiverZip' => 'gmzmiaqefrygmtvssvyflnaukpfmensfdmvcdcdkfypfidqozauppbvcmcsjsutynyipsppsqteaifcjnmexwxfxgunnyhdekycuvvbqyhgrqafrkktwkbfxlzcjoutpcwobzkvtzkvjiswwregrhcejamopavpbmeyjgyygfnuvhgsvzrokgywgrmmwdogemjlbzsgksaicwtbtrxnxticpjaremjnzlvlny',
            'receiverState' => 'uaskiwomlizmurhnmhxbguuccrcfkdgygvkvodheaauvpveddjurthhlbfamwmbpazzqucriafgbxwjfeeoybpwjevdzhfvinuehvjzdtrxgpnqxbnchgghmabnqrgcwngknxzqxvhqyotqkuyoxgvfmqjtgmodncmzgwiajhnguubkhzpvjdbwmmvtyfcaadahdfzmg',
            'receiverCountry' => 'gt',
            'weightLb' => 3661962.65948,
            'weightOz' => 10023170.668946875,
            'length' => 242024.0,
            'width' => 286.3584,
            'height' => 628.3265336,
            'comment' => 'uubnmlepovppqyxbksdlrfrefbxmowkamvhjhahftxiaqkhalegkotoxvmbvvyexfmbxvtaydojidhmjjnzhgztgxnbxhpkvngkjgxfwwufqdlgutipdvtwznwfpcbbuzbarxmvokurkbvahuizevliisysesldikrlngvbkddhqszjnoballnmupcducygmmgopgghazmlyvbdbvsguqfygmytnvewlqrfyoxvhxnvklpuzzckkukgqswetkpetuwqywympfctdikgqjfoakxfdzelsgxcdcxbkumzhjnzigmveqxbsjhxwifrgrnuuyzotuumtywkqekimgqwnecoeledifrxibwhfykmomnwbmdajdptuicgogbftipouquwlgfqgeugmqvdtexyzfmkwddwdzwoggzkthbovjbmctjtiermgwlfukjlbgnexnqwjltsxsclyqdjinyaxztxuwacgmvmgnimhdqjvtratdwknwmgsbjcdnsgcasyrtlggebfgfspovpmvkgpmpaadlwhmupvfwcytrxkxmayxbhjeoivyefywmgjgyfcldvydigmjzrxvkmshsuyxwtmududwyazgazthtiadianwduwzatjyrkonkrvllbgbvmukaudkolcnsfrhoejpkjetuvwtgihdahfsquhsxobwhwacffipofnfitahlifosapipsuefgzoghddpiffeaslzqmguufpeszotonwfmllwaxavfpfrsmhxlgrkiqjrpopymtxtktw',
            'vatTaxId' => 'ey',
            'insurancesStatus' => false,
            'insurances' => 118.54685,
            'externalId' => 'debitis',
            'apiShipMethod' => '2{1,}_3{1,}$/i',
            'packagingId' => 'veritatis',
            'consolidationOrder' => 'qui',
            'skladCreateLabel' => 'soluta',
            'userPackType' => 'amet',
            'productsConsolidationData' => [
                [
                    'id' => 4,
                    'categoryId' => 1,
                    'descrEn' => 'explicabo',
                    'nameId' => 4,
                    'forSelectedId' => 7,
                    'materialId' => 16,
                    'subMaterialId' => 6,
                    'hsCode' => 'voluptas',
                    'price' => 480.5631,
                    'count' => 1,
                ],
            ],
            'productsData' => [
                [
                    'product' => 12,
                    'hsCode' => 'consequatur',
                    'count' => 0,
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://system.skladusa.com/api/order/voluptatem"
);

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

let body = {
    "receiverName": "hqzntuljcdpgkzhzninicgptspuzhoxexgsvahfiscpzztbnqzzmmxxqcjqokslebjivsjszqjqppfb",
    "receiverEmail": "ywydaajuxowvoprurtmqhvavflywjnibzcjcjonsepuhxwsrcvfjtnfbngeehkkkvjrbepaifpimigzmcawjdhabpccprcvdefpuflzyqxujgklfrnfitstyooqfpcygbjfhpcmksciadtlgpgdeaaeneojtjewzenvwcrbjlllseywixrwwjqeniiawjftyljqpahkxedeezfltorfyzwjqphicpwatyiiuza",
    "receiverPhone": "jpiidlvgyxntcyivgmppskvdbwmabrgywncqjosmdxwkcwtiiidmaczkglwhhfbioygmroquagedvuoneeqrxiifjtijnwjgnkrkughjsvmtdgrkjwylfqwfxndbetqbqppuixjuyurzuexilrjkdpkagvcucohnlcgofnurhgadfwgraei",
    "receiverAddress": "hpnxsrxonrnckehxfrwkqutheo",
    "receiverCity": "gdqvufunfartorrwqby",
    "receiverZip": "gmzmiaqefrygmtvssvyflnaukpfmensfdmvcdcdkfypfidqozauppbvcmcsjsutynyipsppsqteaifcjnmexwxfxgunnyhdekycuvvbqyhgrqafrkktwkbfxlzcjoutpcwobzkvtzkvjiswwregrhcejamopavpbmeyjgyygfnuvhgsvzrokgywgrmmwdogemjlbzsgksaicwtbtrxnxticpjaremjnzlvlny",
    "receiverState": "uaskiwomlizmurhnmhxbguuccrcfkdgygvkvodheaauvpveddjurthhlbfamwmbpazzqucriafgbxwjfeeoybpwjevdzhfvinuehvjzdtrxgpnqxbnchgghmabnqrgcwngknxzqxvhqyotqkuyoxgvfmqjtgmodncmzgwiajhnguubkhzpvjdbwmmvtyfcaadahdfzmg",
    "receiverCountry": "gt",
    "weightLb": 3661962.65948,
    "weightOz": 10023170.668946875,
    "length": 242024,
    "width": 286.3584,
    "height": 628.3265336,
    "comment": "uubnmlepovppqyxbksdlrfrefbxmowkamvhjhahftxiaqkhalegkotoxvmbvvyexfmbxvtaydojidhmjjnzhgztgxnbxhpkvngkjgxfwwufqdlgutipdvtwznwfpcbbuzbarxmvokurkbvahuizevliisysesldikrlngvbkddhqszjnoballnmupcducygmmgopgghazmlyvbdbvsguqfygmytnvewlqrfyoxvhxnvklpuzzckkukgqswetkpetuwqywympfctdikgqjfoakxfdzelsgxcdcxbkumzhjnzigmveqxbsjhxwifrgrnuuyzotuumtywkqekimgqwnecoeledifrxibwhfykmomnwbmdajdptuicgogbftipouquwlgfqgeugmqvdtexyzfmkwddwdzwoggzkthbovjbmctjtiermgwlfukjlbgnexnqwjltsxsclyqdjinyaxztxuwacgmvmgnimhdqjvtratdwknwmgsbjcdnsgcasyrtlggebfgfspovpmvkgpmpaadlwhmupvfwcytrxkxmayxbhjeoivyefywmgjgyfcldvydigmjzrxvkmshsuyxwtmududwyazgazthtiadianwduwzatjyrkonkrvllbgbvmukaudkolcnsfrhoejpkjetuvwtgihdahfsquhsxobwhwacffipofnfitahlifosapipsuefgzoghddpiffeaslzqmguufpeszotonwfmllwaxavfpfrsmhxlgrkiqjrpopymtxtktw",
    "vatTaxId": "ey",
    "insurancesStatus": false,
    "insurances": 118.54685,
    "externalId": "debitis",
    "apiShipMethod": "2{1,}_3{1,}$\/i",
    "packagingId": "veritatis",
    "consolidationOrder": "qui",
    "skladCreateLabel": "soluta",
    "userPackType": "amet",
    "productsConsolidationData": [
        {
            "id": 4,
            "categoryId": 1,
            "descrEn": "explicabo",
            "nameId": 4,
            "forSelectedId": 7,
            "materialId": 16,
            "subMaterialId": 6,
            "hsCode": "voluptas",
            "price": 480.5631,
            "count": 1
        }
    ],
    "productsData": [
        {
            "product": 12,
            "hsCode": "consequatur",
            "count": 0
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());
curl --request POST \
    "https://system.skladusa.com/api/order/voluptatem" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: required    Basic + base64 encoded \'user_id:api_token\'" \
    --data "{
    \"receiverName\": \"hqzntuljcdpgkzhzninicgptspuzhoxexgsvahfiscpzztbnqzzmmxxqcjqokslebjivsjszqjqppfb\",
    \"receiverEmail\": \"ywydaajuxowvoprurtmqhvavflywjnibzcjcjonsepuhxwsrcvfjtnfbngeehkkkvjrbepaifpimigzmcawjdhabpccprcvdefpuflzyqxujgklfrnfitstyooqfpcygbjfhpcmksciadtlgpgdeaaeneojtjewzenvwcrbjlllseywixrwwjqeniiawjftyljqpahkxedeezfltorfyzwjqphicpwatyiiuza\",
    \"receiverPhone\": \"jpiidlvgyxntcyivgmppskvdbwmabrgywncqjosmdxwkcwtiiidmaczkglwhhfbioygmroquagedvuoneeqrxiifjtijnwjgnkrkughjsvmtdgrkjwylfqwfxndbetqbqppuixjuyurzuexilrjkdpkagvcucohnlcgofnurhgadfwgraei\",
    \"receiverAddress\": \"hpnxsrxonrnckehxfrwkqutheo\",
    \"receiverCity\": \"gdqvufunfartorrwqby\",
    \"receiverZip\": \"gmzmiaqefrygmtvssvyflnaukpfmensfdmvcdcdkfypfidqozauppbvcmcsjsutynyipsppsqteaifcjnmexwxfxgunnyhdekycuvvbqyhgrqafrkktwkbfxlzcjoutpcwobzkvtzkvjiswwregrhcejamopavpbmeyjgyygfnuvhgsvzrokgywgrmmwdogemjlbzsgksaicwtbtrxnxticpjaremjnzlvlny\",
    \"receiverState\": \"uaskiwomlizmurhnmhxbguuccrcfkdgygvkvodheaauvpveddjurthhlbfamwmbpazzqucriafgbxwjfeeoybpwjevdzhfvinuehvjzdtrxgpnqxbnchgghmabnqrgcwngknxzqxvhqyotqkuyoxgvfmqjtgmodncmzgwiajhnguubkhzpvjdbwmmvtyfcaadahdfzmg\",
    \"receiverCountry\": \"gt\",
    \"weightLb\": 3661962.65948,
    \"weightOz\": 10023170.668946875,
    \"length\": 242024,
    \"width\": 286.3584,
    \"height\": 628.3265336,
    \"comment\": \"uubnmlepovppqyxbksdlrfrefbxmowkamvhjhahftxiaqkhalegkotoxvmbvvyexfmbxvtaydojidhmjjnzhgztgxnbxhpkvngkjgxfwwufqdlgutipdvtwznwfpcbbuzbarxmvokurkbvahuizevliisysesldikrlngvbkddhqszjnoballnmupcducygmmgopgghazmlyvbdbvsguqfygmytnvewlqrfyoxvhxnvklpuzzckkukgqswetkpetuwqywympfctdikgqjfoakxfdzelsgxcdcxbkumzhjnzigmveqxbsjhxwifrgrnuuyzotuumtywkqekimgqwnecoeledifrxibwhfykmomnwbmdajdptuicgogbftipouquwlgfqgeugmqvdtexyzfmkwddwdzwoggzkthbovjbmctjtiermgwlfukjlbgnexnqwjltsxsclyqdjinyaxztxuwacgmvmgnimhdqjvtratdwknwmgsbjcdnsgcasyrtlggebfgfspovpmvkgpmpaadlwhmupvfwcytrxkxmayxbhjeoivyefywmgjgyfcldvydigmjzrxvkmshsuyxwtmududwyazgazthtiadianwduwzatjyrkonkrvllbgbvmukaudkolcnsfrhoejpkjetuvwtgihdahfsquhsxobwhwacffipofnfitahlifosapipsuefgzoghddpiffeaslzqmguufpeszotonwfmllwaxavfpfrsmhxlgrkiqjrpopymtxtktw\",
    \"vatTaxId\": \"ey\",
    \"insurancesStatus\": false,
    \"insurances\": 118.54685,
    \"externalId\": \"debitis\",
    \"apiShipMethod\": \"2{1,}_3{1,}$\\/i\",
    \"packagingId\": \"veritatis\",
    \"consolidationOrder\": \"qui\",
    \"skladCreateLabel\": \"soluta\",
    \"userPackType\": \"amet\",
    \"productsConsolidationData\": [
        {
            \"id\": 4,
            \"categoryId\": 1,
            \"descrEn\": \"explicabo\",
            \"nameId\": 4,
            \"forSelectedId\": 7,
            \"materialId\": 16,
            \"subMaterialId\": 6,
            \"hsCode\": \"voluptas\",
            \"price\": 480.5631,
            \"count\": 1
        }
    ],
    \"productsData\": [
        {
            \"product\": 12,
            \"hsCode\": \"consequatur\",
            \"count\": 0
        }
    ]
}"

Example response (200):

{
"data": [
 {
 "order": {
     "id": 143,
     "receiverName": "receiverName",
     "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",
     "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
         }
      ]
    }
 },
     "status": "success"
}
 

Request      

POST /api/order/{id}

URL Parameters

id  string  

The ID of the order.

orderFbmId  integer optional  

Order Id.

Body Parameters

receiverName  string  

Must not be greater than 255 characters.

receiverEmail  string  

Must be a valid email address. Must not be greater than 255 characters.

receiverPhone  string optional  

Must not be greater than 255 characters.

receiverAddress  string  

Must not be greater than 35 characters.

receiverCity  string  

Must not be greater than 255 characters.

receiverZip  string  

Must not be greater than 255 characters.

receiverState  string  

Must not be greater than 255 characters.

receiverCountry  string  

Must not be greater than 2 characters.

weightLb  number optional  

weightOz  number optional  

length  number optional  

width  number optional  

height  number optional  

comment  string optional  

Must not be greater than 5000 characters.

vatTaxId  string optional  

Must not be greater than 35 characters.

insurancesStatus  boolean optional  

insurances  number optional  

externalId  string optional  

apiShipMethod  string optional  

The value format is invalid.

packagingId  string optional  

consolidationOrder  string  

skladCreateLabel  string  

userPackType  string optional  

productsConsolidationData  object[] optional  

productsConsolidationData[].id  integer optional  

productsConsolidationData[].categoryId  integer optional  

productsConsolidationData[].descrEn  string optional  

productsConsolidationData[].nameId  integer optional  

productsConsolidationData[].forSelectedId  integer optional  

productsConsolidationData[].materialId  integer optional  

productsConsolidationData[].subMaterialId  integer optional  

productsConsolidationData[].hsCode  string optional  

productsConsolidationData[].price  number  

productsConsolidationData[].count  integer  

Must be at least 1.

productsData  object[] optional  

productsData[].product  integer  

productsData[].hsCode  string optional  

productsData[].count  integer  

Must be at least 1.

Products

Display a listing of the products.

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

Display the specified product resource.

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

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/saepe" \
    --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}

URL Parameters

id  string  

The ID of the product.

productId  integer optional  

Product Id.

Store a newly created product.

Example request:
$client = new \GuzzleHttp\Client();
$response = $client->put(
    'https://system.skladusa.com/api/product',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'Authorization' => 'required    Basic + base64 encoded \'user_id:api_token\'',
        ],
        'json' => [
            'name' => 'architecto',
            'title' => 'omnis',
            'upc' => 'fugit',
            'sku' => 'sequi',
        ],
    ]
);
$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": "architecto",
    "title": "omnis",
    "upc": "fugit",
    "sku": "sequi"
};

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\": \"architecto\",
    \"title\": \"omnis\",
    \"upc\": \"fugit\",
    \"sku\": \"sequi\"
}"

Example response (200):

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

Request      

PUT /api/product

Body Parameters

name  string  

title  string  

upc  string  

sku  string  

Update the specified product resource in storage.

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

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

let body = {
    "name": "consequatur",
    "title": "magnam",
    "upc": "nostrum",
    "sku": "eum",
    "productPacketType": false
};

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

Example response (200):

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

Request      

POST /api/product/{id}

URL Parameters

id  string  

The ID of the product.

productId  integer optional  

Product Id.

Body Parameters

name  string  

title  string  

upc  string  

sku  string  

productPacketType  boolean  

Proform Data

Display a listing of the proform data.

requires authentication

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

URL Parameters

page  integer optional  

Current page default 1.

numItemsPerPage  integer optional  

Num Items Per Page by default 20 max per page 100

Display the specified proform data resource.

requires authentication

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

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/officiis" \
    --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}

URL Parameters

id  string  

The ID of the category.

categoryId  integer optional  

Proform Category Data ID.

Search Hs Code by proform options (name_id, material_id)

requires authentication

Example request:
$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://system.skladusa.com/api/proforma-data/hs-code',
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'Authorization' => 'required   Basic + base64 encoded \'user_id:api_token\'',
        ],
        'json' => [
            'nameId' => 18,
            'materialId' => 20,
        ],
    ]
);
$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": 18,
    "materialId": 20
};

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\": 18,
    \"materialId\": 20
}"

Example response (200):

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

Request      

POST /api/proforma-data/hs-code

Body Parameters

nameId  integer  

materialId  integer  

Transactions

Display a listing of the user transactions.

requires authentication

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

URL Parameters

page  integer optional  

Current page default 1.

numItemsPerPage  integer optional  

Num Items Per Page by default 20 max per page 100

Display the specified transaction.

requires authentication

Example request:
$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://system.skladusa.com/api/transactions/12',
    [
        '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/12"
);

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/12" \
    --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}

URL Parameters

id  integer optional  

Transaction Id.

Send tracking number to payment system

requires authentication

Example request:
$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://system.skladusa.com/api/transactions/qui/update-tracking-number',
    [
        '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/qui/update-tracking-number"
);

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

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

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

URL Parameters

id  string  

The ID of the transaction.

transactionId  integer optional  

required. Payment transaction id.

Prepare form for creating order from payment transaction

requires authentication

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

URL Parameters

id  string  

The ID of the transaction.

transactionId  integer optional  

required. Payment transaction id.