openapi: 3.0.3
info:
title: 'Api documentation for SKLAD USA'
description: ''
version: 1.0.0
servers:
-
url: 'https://system.skladusa.com'
paths:
/api/product:
get:
summary: 'Display a listing of the products.'
operationId: displayAListingOfTheProducts
description: ''
parameters: []
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n\"data\": {\n\"entities\": [\n {\n \"product\": {\n \"id\": 85,\n \"name\": \"Monica Panek\",\n \"title\": \"Monica Panek\",\n \"upc\": \"Monica Panek\",\n \"sku\": \"Monica Panek2\",\n \"productPacketType\": 0\n }\n },\n ..............................\n ]\n },\n\"status\": \"success\"\n}"
tags:
- Products
security: []
put:
summary: 'Store a newly created product.'
operationId: storeANewlyCreatedProduct
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 87
status: success
properties:
data:
type: object
properties:
id:
type: integer
example: 87
status:
type: string
example: success
tags:
- Products
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: 'Dusty blue white flower comb Bride Bridesmaid floral hair piece Fall wedding hair accessories'
example: nulla
title:
type: string
description: 'Dusty blue white flower comb Bride Bridesmaid floral hair piece Fall wedding hair accessories'
example: mollitia
upc:
type: string
description: B073QK9LZX
example: aut
sku:
type: string
description: 'B072KG8H4M, BT-F10M-HAER'
example: aliquid
required:
- name
- title
- upc
- sku
security: []
'/api/product/{id}':
get:
summary: 'Display the specified product resource.'
operationId: displayTheSpecifiedProductResource
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
product:
id: 85
name: 'Monica Panek'
title: 'Monica Panek'
upc: 'Monica Panek'
sku: 'Monica Panek2'
productPacketType: 0
status: success
properties:
data:
type: object
properties:
product:
type: object
properties:
id:
type: integer
example: 85
name:
type: string
example: 'Monica Panek'
title:
type: string
example: 'Monica Panek'
upc:
type: string
example: 'Monica Panek'
sku:
type: string
example: 'Monica Panek2'
productPacketType:
type: integer
example: 0
status:
type: string
example: success
tags:
- Products
security: []
post:
summary: 'Update the specified product resource in storage.'
operationId: updateTheSpecifiedProductResourceInStorage
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
- 'Somehow valid'
status: success
properties:
data:
type: array
example:
- 'Somehow valid'
items:
type: string
status:
type: string
example: success
tags:
- Products
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: 'Dusty blue white flower comb Bride Bridesmaid floral hair piece Fall wedding hair accessories'
example: natus
title:
type: string
description: 'Dusty blue white flower comb Bride Bridesmaid floral hair piece Fall wedding hair accessories'
example: alias
upc:
type: string
description: B073QK9LZX
example: rerum
sku:
type: string
description: 'B072KG8H4M, BT-F10M-HAER'
example: aut
productPacketType:
type: boolean
description: '(0 | 1)'
example: false
required:
- name
- title
- upc
- sku
- productPacketType
security: []
parameters:
-
in: path
name: id
description: 'The ID of the product.'
example: quisquam
required: true
schema:
type: string
-
in: path
name: productId
description: 'Optional parameter. Product Id.'
required: true
schema:
type: integer
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: 10
/api/proforma-data/category:
get:
summary: 'Display a listing of the proform data.'
operationId: displayAListingOfTheProformData
description: ''
parameters: []
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n\"data\": {\n\"entities\": [\n{\n\"id\": 1,\n\"nameEn\": \"Mechanical parts and tools\",\n\"nameUa\": \"Механічні деталі та інструменти\",\n\"nameRu\": \"Механические части и инструменты\",\n\"names\": [\n {\n \"id\": 328,\n \"nameUa\": \"ІГРАШКА\",\n \"nameEn\": \"TOY\",\n \"nameRu\": \"ИГРУШКА\"\n },\n ............\n ],\n \"materials\": [\n {\n \"id\": 329,\n \"nameUa\": \"ФЕТР\",\n \"nameEn\": \"FELT\",\n \"nameRu\": \"фетр\"\n },\n .........\n ],\n \"for\": [\n {\n \"id\": 4,\n \"nameUa\": \"ЖІНОЧА\",\n \"nameEn\": \"WOMENS\",\n \"nameRu\": \"Женская\"\n },\n .................\n ],\n \"subMaterials\": [\n {\n \"id\": 3,\n \"nameUa\": \"ТКАНИЙ \",\n \"nameEn\": \"WOVEN\",\n \"nameRu\": \"ТКАНИЙ \"\n },\n ............\n ]\n },\n ......\n ],\n\"pagination\": {\n \"last\": 1,\n \"current\": 0,\n \"numItemsPerPage\": 10,\n \"first\": 1,\n \"pageCount\": 1,\n \"totalCount\": 7,\n \"pageRange\": 1,\n \"startPage\": 1,\n \"endPage\": 1,\n \"previous\": 0,\n \"next\": 1,\n \"pagesInRange\": [\n 1\n ],\n \"firstPageInRange\": 1,\n \"lastPageInRange\": 1,\n \"currentItemCount\": 10,\n \"firstItemNumber\": 11,\n \"lastItemNumber\": 1\n }\n},\n\"status\": \"success\"\n}"
tags:
- 'Proform Data'
parameters:
-
in: path
name: page
description: 'Optional parameter. Current page default 1.'
required: true
schema:
type: integer
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: 12
-
in: path
name: numItemsPerPage
description: 'Optional parameter. Num Items Per Page by default 20 max per page 100'
required: true
schema:
type: integer
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: 18
'/api/proforma-data/category/{id}':
get:
summary: 'Display the specified proform data resource.'
operationId: displayTheSpecifiedProformDataResource
description: ''
parameters: []
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n\"data\": {\n\"entities\": [\n {\n \"id\": 4,\n \"nameEn\": \"Toys & Entertainment\",\n \"nameUa\": \"Іграшки та розваги\",\n \"nameRu\": \"Игрушки и развлечения\",\n \"names\": [\n {\n \"id\": 328,\n \"nameUa\": \"ІГРАШКА\",\n \"nameEn\": \"TOY\",\n \"nameRu\": \"ИГРУШКА\"\n },\n ...........\n ],\n \"materials\": [\n {\n \"id\": 329,\n \"nameUa\": \"ФЕТР\",\n \"nameEn\": \"FELT\",\n \"nameRu\": \"фетр\"\n },\n .............\n ],\n \"for\": [\n {\n \"id\": 4,\n \"nameUa\": \"ЖІНОЧА\",\n \"nameEn\": \"WOMENS\",\n \"nameRu\": \"Женская\"\n },\n ],\n \"subMaterials\": [\n {\n \"id\": 330,\n \"nameUa\": \"ТКАНИЙ \",\n \"nameEn\": \"WOVEN\",\n \"nameRu\": \"ТКАНЫЙ\"\n },\n ..........\n ]\n }\n]\n},\n\"status\": \"success\"\n}"
tags:
- 'Proform Data'
parameters:
-
in: path
name: id
description: 'The ID of the category.'
example: quasi
required: true
schema:
type: string
-
in: path
name: categoryId
description: 'Optional parameter. Proform Category Data ID.'
required: true
schema:
type: integer
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: 17
/api/proforma-data/hs-code:
post:
summary: 'Search Hs Code by proform options (name_id, material_id)'
operationId: searchHsCodeByProformOptionsnameIdMaterialId
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
hsCode: oo1430NSOVmFUieS
status: success
properties:
data:
type: object
properties:
hsCode:
type: string
example: oo1430NSOVmFUieS
status:
type: string
example: success
tags:
- 'Proform Data'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
nameId:
type: integer
description: 'Proform Data name Id'
example: 16
materialId:
type: integer
description: 'Proform Data material Id'
example: 19
/api/key-crm/create-order:
get:
summary: 'Prepare order data for Key Crm.'
operationId: prepareOrderDataForKeyCrm
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: success
request:
receiverName: 'Bogdan Postavenskyi'
receiverEmail: support@skladusa.com
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: support@skladusa.com
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
properties:
status:
type: string
example: success
request:
type: object
properties:
receiverName:
type: string
example: 'Bogdan Postavenskyi'
receiverEmail:
type: string
example: support@skladusa.com
receiverPhone:
type: string
example: '+380 932623600'
receiverAddress:
type: string
example: 'вулиця Перемоги'
receiverCity:
type: string
example: Житомир
receiverZip:
type: string
example: '10000'
receiverState:
type: string
example: 'Житомирська область'
receiverCountry:
type: string
example: null
weightLb:
type: string
example: null
weightOz:
type: string
example: null
length:
type: string
example: null
width:
type: string
example: null
height:
type: string
example: null
comment:
type: string
example: null
insurancesStatus:
type: string
example: null
insurances:
type: string
example: null
externalId:
type: string
example: null
apiShipMethod:
type: string
example: null
packagingId:
type: string
example: null
consolidationOrder:
type: boolean
example: true
skladCreateLabel:
type: boolean
example: false
userPackType:
type: string
example: null
productsData:
type: string
example: null
productsConsolidationData:
type: array
example:
-
descrEn: 'test listing'
count: 1
items:
type: object
properties:
descrEn:
type: string
example: 'test listing'
count:
type: integer
example: 1
transactionId:
type: integer
example: 24234
order:
type: object
properties:
id:
type: integer
example: 584
receiverName:
type: string
example: 'Bogdan Postavenskyi'
createdAtStr:
type: string
example: '2022-05-24 15:30:17'
receiverEmail:
type: string
example: support@skladusa.com
receiverAddress:
type: string
example: '1630 91ST AVE NE STE 180'
receiverCity:
type: string
example: Blaine
receiverZip:
type: string
example: '55449'
receiverState:
type: string
example: MN
receiverCountry:
type: string
example: 'United States'
receiverPhone:
type: string
example: '101010'
comment:
type: string
example: null
weightLb:
type: integer
example: 0
weightOz:
type: integer
example: 2
length:
type: string
example: null
width:
type: integer
example: 2
height:
type: string
example: null
consolidationOrder:
type: boolean
example: false
skladCreateLabel:
type: boolean
example: false
shipDate:
type: object
properties:
date:
type: string
example: '2022-05-24 13:38:40.000000'
timezone_type:
type: integer
example: 3
timezone:
type: string
example: Europe/Kiev
shippingCosts:
type: string
example: '3.37'
insurancesStatus:
type: boolean
example: true
insurances:
type: string
example: '0.2'
externalId:
type: string
example: null
apiShipMethod:
type: string
example: '1_1'
packagingId:
type: integer
example: 18
userPackType:
type: string
example: pack1
status:
type: string
example: null
vatTaxId:
type: integer
example: 641
transactionId:
type: integer
example: 24234
productsData:
type: array
example:
-
productData:
count: 1
product: 1548
items:
type: object
properties:
productData:
type: object
properties:
count:
type: integer
example: 1
product:
type: integer
example: 1548
productsConsolidationData:
type: array
example: []
transactionInfo:
type: object
properties:
gross:
type: integer
example: 2
ppFee:
type: number
example: 0.38
skladUsaFee:
type: number
example: 0.03
sum:
type: number
example: 1.59
tags:
- 'Key Crm'
parameters:
-
in: path
name: orderType
description: 'Optional parameter. set orderType one from list consolidation, self:create, sklad:create set consolidation if empty.'
required: true
schema:
type: string
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: enim
-
in: path
name: transaction
description: 'Optional parameter. transaction number.'
required: true
schema:
type: string
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: iusto
-
in: path
name: etsy
description: 'Optional parameter. etsy order id.'
required: true
schema:
type: string
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: voluptatem
/api/key-crm/rate/list:
post:
summary: 'Get Rate List for Key Crm'
operationId: getRateListForKeyCrm
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
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'
properties:
status:
type: string
example: success
data:
type: object
properties:
case:
type: object
properties:
fromCountry:
type: string
example: Ukraine
fromCountryCode:
type: string
example: UA
toCountry:
type: string
example: Germany
toCountryCode:
type: string
example: DE
stateCode:
type: string
example: null
zipCode:
type: string
example: '10179'
city:
type: string
example: Berlin
weight:
type: string
example: '1'
length:
type: string
example: '1'
width:
type: string
example: '1'
height:
type: string
example: '1'
clientPayPal:
type: boolean
example: true
shippingPrices:
type: array
example:
-
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'
items:
type: object
properties:
type:
type: string
example: consolidation
consolidation_type:
type: string
example: consolidation
system_key:
type: string
example: DHLExpress
currency:
type: string
example: USD
description:
type: string
example: 'DHLExpress, ExpressWorldwideNonDoc Parcel'
costs:
type: object
properties:
price:
type: string
example: '37.16'
fee:
type: integer
example: 2
apiShipMethod:
type: string
example: ExpressWorldwideNonDoc
tags:
- 'Key Crm'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
senderCountryCode:
type: required
description: 'string Sender country code.'
example: dignissimos
length:
type: required
description: 'string Length,sm.'
example: iusto
height:
type: required
description: 'string Height,sm.'
example: similique
width:
type: required
description: 'string Width,sm.'
example: deserunt
weight:
type: required
description: 'string Weight,kg.'
example: praesentium
countryCode:
type: required
description: 'string Country code.'
example: officia
stateCode:
type: string
description: 'Need when Country code - US.'
example: est
zipCode:
type: required
description: 'string Zip (postal) code.'
example: doloremque
city:
type: required
description: 'string City.'
example: consequatur
clientPayPal:
type: required
description: 'boolean PayPal client.'
example: autem
/api/transactions:
get:
summary: 'Display a listing of the user transactions.'
operationId: displayAListingOfTheUserTransactions
description: ''
parameters: []
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n\"data\": {\n \"entities\": [\n {\n \"transaction\": {\n \"id\": 125050,\n \"orderId\": null,\n \"shopName\": \"UkiTreasures\",\n \"createdAt\": \"2021-05-04 15:21:22\",\n \"number\": \"7022037960438191Y\",\n \"payedUserName\": \"Meredith Zoul\",\n \"payedUserEmail\": \"mlzoulosu@gmail.com\",\n \"addressPart\": \"365 S Roys Ave\",\n \"totalSum\": \"85.99\",\n \"tax\": \"6.00\",\n \"interimSum\": \"77.71\",\n \"commission\": \"2.28\",\n \"deductionForUserBonus\": 0,\n \"deductionForSystem\": \"2.33\",\n \"sum\": \"75.38\",\n \"noteText\": null,\n \"country\": \"United States\",\n \"userPhone\": \"330-671-7480\",\n \"userState\": \"OH\",\n \"zip\": \"43204\",\n \"city\": \"Columbus\",\n \"paymentStatus\": \"Completed\",\n \"description\": \"Item #644068700 - SIMPSONS PORTRAIT on the couch, simpsons family portrait, Simpson couple portrait, cartoon portrait, simpsons couch, turn photo $79.99 (1 pc)\"\n }\n }\n ],\n \"pagination\": {\n \"last\": 329,\n \"current\": 2,\n \"numItemsPerPage\": \"1\",\n \"first\": 1,\n \"pageCount\": 329,\n \"totalCount\": 329,\n \"pageRange\": 329,\n \"startPage\": 1,\n \"endPage\": 329,\n \"previous\": 1,\n \"next\": 3,\n \"pagesInRange\": [\n 1,\n 2,\n 3,\n 4,\n ],\n \"firstPageInRange\": 1,\n \"lastPageInRange\": 329,\n \"currentItemCount\": \"1\",\n \"firstItemNumber\": 2,\n \"lastItemNumber\": 2\n }\n },\n \"status\": \"success\"\n}"
tags:
- Transactions
parameters:
-
in: path
name: page
description: 'Optional parameter. Current page default 1.'
required: true
schema:
type: integer
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: 8
-
in: path
name: numItemsPerPage
description: 'Optional parameter. Num Items Per Page by default 20 max per page 100'
required: true
schema:
type: integer
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: 8
'/api/transactions/{id}':
get:
summary: 'Display the specified transaction.'
operationId: displayTheSpecifiedTransaction
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
transaction:
id: 125050
orderId: null
shopName: UkiTreasures
createdAt: '2021-05-04 15:21:22'
number: 7004437960438191Y
payedUserName: 'Meredith Zoul'
payedUserEmail: mlzoulosu@gmail.com
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
properties:
data:
type: object
properties:
transaction:
type: object
properties:
id:
type: integer
example: 125050
orderId:
type: string
example: null
shopName:
type: string
example: UkiTreasures
createdAt:
type: string
example: '2021-05-04 15:21:22'
number:
type: string
example: 7004437960438191Y
payedUserName:
type: string
example: 'Meredith Zoul'
payedUserEmail:
type: string
example: mlzoulosu@gmail.com
addressPart:
type: string
example: '365 S Roys Ave'
totalSum:
type: string
example: '85.99'
tax:
type: string
example: '6.00'
interimSum:
type: string
example: '77.71'
commission:
type: string
example: '2.28'
deductionForUserBonus:
type: integer
example: 0
deductionForSystem:
type: string
example: '2.33'
sum:
type: string
example: '75.38'
itemNumber:
type: object
properties: { }
noteText:
type: string
example: null
country:
type: string
example: 'United States'
userPhone:
type: string
example: 330-671-7480
userState:
type: string
example: OH
zip:
type: string
example: '43204'
city:
type: string
example: Columbus
paymentStatus:
type: string
example: Completed
description:
type: string
example: 'Item #644068700 - SIMPSONS PORTRAIT on the couch, simpsons family portrait, Simpson couple portrait, cartoon portrait, simpsons couch, turn photo $79.99 (1 pc)'
status:
type: string
example: success
tags:
- Transactions
parameters:
-
in: path
name: id
description: 'Optional parameter. Transaction Id.'
required: true
schema:
type: integer
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: 6
'/api/transactions/{id}/update-tracking-number':
post:
summary: 'Send tracking number to payment system'
operationId: sendTrackingNumberToPaymentSystem
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: ok
message: 'tracking-number send to transaction'
pay-system-status: success
pay-system-message: 'send to pay system'
properties:
status:
type: string
example: ok
message:
type: string
example: 'tracking-number send to transaction'
pay-system-status:
type: string
example: success
pay-system-message:
type: string
example: 'send to pay system'
tags:
- Transactions
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
tracking-number:
type: required
description: 'string tracking number'
example: in
parameters:
-
in: path
name: id
description: 'The ID of the transaction.'
example: et
required: true
schema:
type: string
-
in: path
name: transactionId
description: 'Optional parameter. required. Payment transaction id.'
required: true
schema:
type: integer
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: 19
'/api/transactions/{id}/create-order':
get:
summary: 'Prepare form for creating order from payment transaction'
operationId: prepareFormForCreatingOrderFromPaymentTransaction
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: success
request:
receiverName: 'Meredith Zoul'
receiverEmail: mlzoulosu@gmail.com
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
properties:
status:
type: string
example: success
request:
type: object
properties:
receiverName:
type: string
example: 'Meredith Zoul'
receiverEmail:
type: string
example: mlzoulosu@gmail.com
receiverPhone:
type: string
example: 330-671-7480
receiverAddress:
type: string
example: '365 S Roys Ave'
receiverCity:
type: string
example: Columbus
receiverZip:
type: string
example: '43204'
receiverState:
type: string
example: OH
receiverCountry:
type: string
example: 'United States'
weightLb:
type: string
example: null
weightOz:
type: string
example: null
length:
type: string
example: null
width:
type: string
example: null
height:
type: string
example: null
comment:
type: string
example: null
insurancesStatus:
type: string
example: null
insurances:
type: string
example: null
externalId:
type: string
example: null
apiShipMethod:
type: string
example: null
packagingId:
type: string
example: null
consolidationOrder:
type: boolean
example: true
skladCreateLabel:
type: boolean
example: true
userPackType:
type: string
example: null
transactionId:
type: integer
example: 125050
productsData:
type: string
example: null
productsConsolidationData:
type: string
example: null
order:
type: string
example: null
tags:
- Transactions
parameters:
-
in: path
name: id
description: 'The ID of the transaction.'
example: sequi
required: true
schema:
type: string
-
in: path
name: transactionId
description: 'Optional parameter. required. Payment transaction id.'
required: true
schema:
type: integer
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: 18
/api/order:
get:
summary: 'Display a listing of the order fbm data.'
operationId: displayAListingOfTheOrderFbmData
description: ''
parameters: []
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n\"data\": {\n\"entities\": [\n \"order\": {\n \"id\": 143,\n \"receiverName\": \"receiverName\",\n \"recipientCompanyName\": \"recipientCompanyName\",\n \"createdAtStr\": \"2022-05-05 13:58:38\",\n \"receiverEmail\": \"receiverEmail@sdddd.dd\",\n \"receiverAddress\": \"receiver Address line 1\",\n \"receiverAddress1\": \"receiver Address line 2\"\n \"receiverCity\": \"receiverCity\",\n \"receiverZip\": \"receiverZip\",\n \"receiverState\": \"receiverState\",\n \"receiverCountry\": \"Ukraine\",\n \"receiverPhone\": \"0989701676\",\n \"comment\": null,\n \"weightLb\": 11,\n \"weightOz\": 4,\n \"length\": 20,\n \"width\": 180,\n \"height\": 20,\n \"consolidationOrder\": false,\n \"skladCreateLabel\": true,\n \"shipDate\": {\n \"date\": \"2022-05-06 12:23:30.698958\",\n \"timezone_type\": 3,\n \"timezone\": \"Europe/Kiev\"\n },\n \"shippingCosts\": null,\n \"insurancesStatus\": false,\n \"insurances\": null,\n \"externalId\": \"1988820690\",\n \"apiShipMethod\": \"1_1\",\n \"packagingId\": null,\n \"userPackType\": \"pack1\",\n \"status\": null,\n \"vatTaxId\": 81,\n \"transactionId\": null,\n \"productsData\": [],\n \"storageId\": 1,\n \"productsConsolidationData\": {\n \"content\": [\n {\n \"forSelectedId\": 4,\n \"forSelectedEn\": \"WOMENS\",\n \"forSelectedUa\": \"ЖІНОЧА\",\n \"forSelectedRu\": \"Женская\",\n \"nameId\": 328,\n \"nameEn\": \"TOY\",\n \"nameUa\": \"ІГРАШКА\",\n \"nameRu\": \"ИГРУШКА\",\n \"materialId\": 329,\n \"materialEn\": \"FELT\",\n \"materialUa\": \"ФЕТР\",\n \"materialRu\": \"фетр\",\n \"subMaterialId\": 330,\n \"subMaterialEn\": \"WOVEN\",\n \"subMaterialUa\": \"ТКАНИЙ \",\n \"subMaterialRu\": \"ТКАНЫЙ\",\n \"categoryId\": 8,\n \"categoryName\": \"Clothes & woven decor\",\n \"count\": 1\n },\n {\n \"forSelectedId\": 4,\n \"forSelectedEn\": \"WOMENS\",\n \"forSelectedUa\": \"ЖІНОЧА\",\n \"forSelectedRu\": \"Женская\",\n \"nameId\": 331,\n \"nameEn\": \"KNITTED WOVEN TOY\",\n \"nameUa\": \"ІГРАШКА В'ЯЗАНА \",\n \"nameRu\": \"ИГРУШКА вязанная\",\n \"materialId\": 332,\n \"materialEn\": \"COTTON\",\n \"materialUa\": \"БАВОВНА\",\n \"materialRu\": \"Хлопок\",\n \"subMaterialId\": 333,\n \"subMaterialEn\": \"EMBROIDERED\",\n \"subMaterialUa\": \"ВИШИТИЙ\",\n \"subMaterialRu\": \"вышитый\",\n \"categoryId\": 8,\n \"categoryName\": \"Clothes & woven decor\",\n \"count\": 2\n }\n ]\n },\n \"sendFrom\": {\n \"first_name\": \"test firstnam112222e\",\n \"last_name\": \"test lastname11\",\n \"company_name\": \"test companynam11e\",\n \"full_name\": \"test firstnam112222e test lastname11\",\n \"label\": \"test firstnam112222e test lastname11 test companynam11e\"\n },\n \"sendFromId\": \"9\"\n },\n }\n ............\n ]\n}\n],\n\"pagination\": {\n \"last\": 2,\n \"current\": 0,\n \"numItemsPerPage\": 10,\n \"first\": 1,\n \"pageCount\": 2,\n \"totalCount\": 19,\n \"pageRange\": 2,\n \"startPage\": 1,\n \"endPage\": 2,\n \"previous\": 0,\n \"next\": 1,\n \"pagesInRange\": [\n 1,\n 2\n ],\n \"firstPageInRange\": 1,\n \"lastPageInRange\": 2,\n \"currentItemCount\": 10,\n \"firstItemNumber\": 11,\n \"lastItemNumber\": 2\n }\n},\n\"status\": \"success\"\n}"
tags:
- 'Orders FBM'
put:
summary: 'Store the specified order fbm resource.'
operationId: storeTheSpecifiedOrderFbmResource
description: ''
parameters: []
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n\"data\": [\n {\n \"order\": {\n \"id\": 143,\n \"receiverName\": \"receiverName\",\n \"recipientCompanyName\": \"recipientCompanyName\",\n \"createdAtStr\": \"2022-05-05 13:58:38\",\n \"receiverEmail\": \"receiverEmail@sdddd.dd\",\n \"receiverAddress\": \"receiverAddress\",\n \"receiverCity\": \"receiverCity\",\n \"receiverZip\": \"receiverZip\",\n \"receiverState\": \"receiverState\",\n \"receiverCountry\": \"Ukraine\",\n \"receiverPhone\": \"0989701676\",\n \"comment\": null,\n \"weightLb\": 11,\n \"weightOz\": 4,\n \"length\": 20,\n \"width\": 180,\n \"height\": 20,\n \"consolidationOrder\": false,\n \"skladCreateLabel\": true,\n \"shipDate\": {\n \"date\": \"2022-05-06 12:23:30.698958\",\n \"timezone_type\": 3,\n \"timezone\": \"Europe/Kiev\"\n },\n \"shippingCosts\": null,\n \"insurancesStatus\": false,\n \"insurances\": null,\n \"externalId\": \"1988820690\",\n \"storageId\" : 1,\n \"apiShipMethod\": \"1_1\",\n \"packagingId\": null,\n \"userPackType\": \"pack1\",\n \"status\": null,\n \"vatTaxId\": 81,\n \"transactionId\": null,\n \"productsData\": [],\n \"productsConsolidationData\": {\n \"content\": [\n {\n \"forSelectedId\": 4,\n \"forSelectedEn\": \"WOMENS\",\n \"forSelectedUa\": \"ЖІНОЧА\",\n \"forSelectedRu\": \"Женская\",\n \"nameId\": 328,\n \"nameEn\": \"TOY\",\n \"nameUa\": \"ІГРАШКА\",\n \"nameRu\": \"ИГРУШКА\",\n \"materialId\": 329,\n \"materialEn\": \"FELT\",\n \"materialUa\": \"ФЕТР\",\n \"materialRu\": \"фетр\",\n \"subMaterialId\": 330,\n \"subMaterialEn\": \"WOVEN\",\n \"subMaterialUa\": \"ТКАНИЙ \",\n \"subMaterialRu\": \"ТКАНЫЙ\",\n \"categoryId\": 8,\n \"categoryName\": \"Clothes & woven decor\",\n \"count\": 1\n },\n {\n \"forSelectedId\": 4,\n \"forSelectedEn\": \"WOMENS\",\n \"forSelectedUa\": \"ЖІНОЧА\",\n \"forSelectedRu\": \"Женская\",\n \"nameId\": 331,\n \"nameEn\": \"KNITTED WOVEN TOY\",\n \"nameUa\": \"ІГРАШКА В'ЯЗАНА \",\n \"nameRu\": \"ИГРУШКА вязанная\",\n \"materialId\": 332,\n \"materialEn\": \"COTTON\",\n \"materialUa\": \"БАВОВНА\",\n \"materialRu\": \"Хлопок\",\n \"subMaterialId\": 333,\n \"subMaterialEn\": \"EMBROIDERED\",\n \"subMaterialUa\": \"ВИШИТИЙ\",\n \"subMaterialRu\": \"вышитый\",\n \"categoryId\": 8,\n \"categoryName\": \"Clothes & woven decor\",\n \"count\": 2\n }\n ]\n }\n \"sendFrom\": {\n \"first_name\": \"test firstnam112222e\",\n \"last_name\": \"test lastname11\",\n \"company_name\": \"test companynam11e\",\n \"full_name\": \"test firstnam112222e test lastname11\",\n \"label\": \"test firstnam112222e test lastname11 test companynam11e\"\n },\n \"sendFromId\": \"9\"\n },\n \"status\": \"success\"\n}"
tags:
- 'Orders FBM'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
receiverName:
type: required
description: 'string Receiver name'
example: inventore
recipientCompanyName:
type: required
description: 'string Receiver company name'
example: quaerat
receiverEmail:
type: required
description: 'string Receiver email'
example: kaci51@example.net
receiverPhone:
type: string
description: 'Receiver phone'
example: perspiciatis
receiverAddress:
type: required
description: 'string Receiver address line 1'
example: aliquam
receiverAddress1:
type: string
description: 'Receiver address line 2'
example: sapiente
receiverCity:
type: required
description: 'string Receiver city'
example: ut
receiverZip:
type: required
description: 'string Receiver zip number'
example: ut
receiverState:
type: required
description: 'string Receiver state'
example: pariatur
receiverCountry:
type: required
description: 'string Receiver country (Code iso 2)'
example: quisquam
storageId:
type: integer
description: 'storage Id can get in route "https://system.skladusa.com/api/storage/order-fbm"'
example: 3
weightLb:
type: numeric
description: 'Weight in pound'
example: totam
weightOz:
type: numeric
description: 'Weight in ounce'
example: molestiae
length:
type: numeric
description: 'Length in sm'
example: quia
width:
type: numeric
description: 'Width in sm'
example: asperiores
height:
type: numeric
description: 'Height in sm'
example: incidunt
comment:
type: string
description: Comment
example: dolor
vatTaxId:
type: string
description: VATTAXID
example: consequuntur
insurancesStatus:
type: boolean
description: 'Insurance? 0=No; 1=Yes'
example: true
insurances:
type: numeric
description: 'Insurance Amount'
example: similique
transactionId:
type: number
description: ''
example: 8390466.494406
externalId:
type: string
description: 'External Id max lenth 256'
example: asperiores
apiShipMethod:
type: string
description: 'Ship Method (999_999)'
example: labore
packagingId:
type: string
description: 'External packaging Id'
example: sit
consolidationOrder:
type: required
description: 'bool Consolidation order ? 0=No; 1=Yes'
example: rerum
skladCreateLabel:
type: required
description: 'bool Sklad Create Label for order ? 0=No; 1=Yes'
example: est
userPackType:
type: string
description: 'pack1 - Warehouse discretion, pack2 - Package, pack3 - Bubbles pack, pack4 - Carton'
example: quia
productsConsolidationData:
type: required
description: 'array Array or object productConsolidationType'
example: consequuntur
productsData:
type: array
description: 'This field is required when consolidationOrder is 0.'
example:
- debitis
items:
type: integer
sendFromId:
type: int|null
description: 'Selected send from address id (може бути не вказано, у такому разі буде використаний перший з створених користувачем)'
example: voluptatum
parameters:
-
in: path
name: page
description: 'Optional parameter. Current page default 1.'
required: true
schema:
type: integer
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: 4
-
in: path
name: numItemsPerPage
description: 'Optional parameter. Num Items Per Page by default 20 max per page 100'
required: true
schema:
type: integer
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: 6
/api/order/example:
get:
summary: 'Display example of the order fbm body response.'
operationId: displayExampleOfTheOrderFbmBodyResponse
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
receiverName: 'Carol Ann Dayton'
createdAtStr: '2018-10-08 07:30:46'
receiverEmail: carolann11@charter.net
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'
properties:
receiverName:
type: string
example: 'Carol Ann Dayton'
createdAtStr:
type: string
example: '2018-10-08 07:30:46'
receiverEmail:
type: string
example: carolann11@charter.net
receiverAddress:
type: string
example: 'Carol Ann Dayton, United States, NC, 28752, Marion, 36 Katydid Drive,'
receiverAddress1:
type: string
example: 'receiver Address line 2'
receiverCity:
type: string
example: Marion
receiverZip:
type: string
example: '28752'
receiverState:
type: string
example: Marion
receiverCountry:
type: string
example: US
receiverPhone:
type: string
example: Marion
comment:
type: string
example: ''
weightLb:
type: string
example: ''
weightOz:
type: string
example: ''
length:
type: string
example: ''
width:
type: string
example: ''
height:
type: string
example: ''
consolidationOrder:
type: integer
example: 1
skladCreateLabel:
type: integer
example: 0
productsConsolidationData:
type: array
example:
-
descrEn: 'Product One'
count: '2'
-
descrEn: 'Product Two'
count: '3'
items:
type: object
properties:
descrEn:
type: string
example: 'Product One'
count:
type: string
example: '2'
tags:
- 'Orders FBM'
/api/shipping-method:
get:
summary: 'Display a listing of the shipping methods.'
operationId: displayAListingOfTheShippingMethods
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
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
properties:
data:
type: object
properties:
entities:
type: array
example:
-
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'
items:
type: object
properties:
name:
type: string
example: USPS
id:
type: string
example: '1_1'
forUSA:
type: string
example: 'Yes'
forNonUSA:
type: string
example: 'No'
status:
type: string
example: success
tags:
- 'Orders FBM'
'/api/order/{id}/get-delivery-methods':
get:
summary: 'Display the delivery methods for order fbm resource.'
operationId: displayTheDeliveryMethodsForOrderFbmResource
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: success
data:
-
serviceName: 'USPS, Priority Mail'
serviceId: 'USPS:Priority:Parcel'
shippingCosts: '9.01'
properties:
status:
type: string
example: success
data:
type: array
example:
-
serviceName: 'USPS, Priority Mail'
serviceId: 'USPS:Priority:Parcel'
shippingCosts: '9.01'
items:
type: object
properties:
serviceName:
type: string
example: 'USPS, Priority Mail'
serviceId:
type: string
example: 'USPS:Priority:Parcel'
shippingCosts:
type: string
example: '9.01'
tags:
- 'Orders FBM'
parameters:
-
in: path
name: id
description: 'The ID of the order.'
example: sint
required: true
schema:
type: string
-
in: path
name: orderFbmId
description: 'Optional parameter. Order Id.'
required: true
schema:
type: integer
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: 4
/api/user-pack-type:
get:
summary: 'Display a listing of the packing types.'
operationId: displayAListingOfThePackingTypes
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: pack1
name: 'Определяет склад'
-
id: pack2
name: Пакет
-
id: pack3
name: 'Пузырчатый пакет'
-
id: pack4
name: Коробка
-
id: pack5
name: 'Подарочный пакет'
status: success
properties:
data:
type: array
example:
-
id: pack1
name: 'Определяет склад'
-
id: pack2
name: Пакет
-
id: pack3
name: 'Пузырчатый пакет'
-
id: pack4
name: Коробка
-
id: pack5
name: 'Подарочный пакет'
items:
type: object
properties:
id:
type: string
example: pack1
name:
type: string
example: 'Определяет склад'
status:
type: string
example: success
tags:
- 'Orders FBM'
/api/packaging-type:
get:
summary: 'Get packing type price list for order.'
operationId: getPackingTypePriceListForOrder
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
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
properties:
data:
type: object
properties:
entities:
type: array
example:
-
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]'
items:
type: object
properties:
id:
type: integer
example: 7
name:
type: string
example: "$0 [Don't need extra packaging]"
status:
type: string
example: success
tags:
- 'Orders FBM'
'/api/order/{id}':
get:
summary: 'Display the specified order fbm resource.'
operationId: displayTheSpecifiedOrderFbmResource
description: ''
parameters: []
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n\"data\": [\n {\n \"order\": {\n \"id\": 143,\n \"receiverName\": \"receiverName\",\n \"recipientCompanyName\": \"recipientCompanyName\",\n \"createdAtStr\": \"2022-05-05 13:58:38\",\n \"receiverEmail\": \"receiverEmail@sdddd.dd\",\n \"receiverAddress\": \"receiverAddress\",\n \"receiverAddress1\": \"receiver Address line 2\",\n \"receiverCity\": \"receiverCity\",\n \"receiverZip\": \"receiverZip\",\n \"receiverState\": \"receiverState\",\n \"receiverCountry\": \"Ukraine\",\n \"receiverPhone\": \"0989701676\",\n \"comment\": null,\n \"weightLb\": 11,\n \"weightOz\": 4,\n \"length\": 20,\n \"width\": 180,\n \"height\": 20,\n \"consolidationOrder\": false,\n \"skladCreateLabel\": true,\n \"shipDate\": {\n \"date\": \"2022-05-06 12:23:30.698958\",\n \"timezone_type\": 3,\n \"timezone\": \"Europe/Kiev\"\n },\n \"shippingCosts\": null,\n \"insurancesStatus\": false,\n \"insurances\": null,\n \"externalId\": \"1988820690\",\n \"apiShipMethod\": \"1_1\",\n \"packagingId\": null,\n \"userPackType\": \"pack1\",\n \"status\": null,\n \"vatTaxId\": 81,\n \"transactionId\": null,\n \"storageId\": 1,\n \"productsData\": [],\n \"productsConsolidationData\": {\n \"content\": [\n {\n \"forSelectedId\": 4,\n \"forSelectedEn\": \"WOMENS\",\n \"forSelectedUa\": \"ЖІНОЧА\",\n \"forSelectedRu\": \"Женская\",\n \"nameId\": 328,\n \"nameEn\": \"TOY\",\n \"nameUa\": \"ІГРАШКА\",\n \"nameRu\": \"ИГРУШКА\",\n \"materialId\": 329,\n \"materialEn\": \"FELT\",\n \"materialUa\": \"ФЕТР\",\n \"materialRu\": \"фетр\",\n \"subMaterialId\": 330,\n \"subMaterialEn\": \"WOVEN\",\n \"subMaterialUa\": \"ТКАНИЙ \",\n \"subMaterialRu\": \"ТКАНЫЙ\",\n \"categoryId\": 8,\n \"categoryName\": \"Clothes & woven decor\",\n \"count\": 1\n },\n {\n \"forSelectedId\": 4,\n \"forSelectedEn\": \"WOMENS\",\n \"forSelectedUa\": \"ЖІНОЧА\",\n \"forSelectedRu\": \"Женская\",\n \"nameId\": 331,\n \"nameEn\": \"KNITTED WOVEN TOY\",\n \"nameUa\": \"ІГРАШКА В'ЯЗАНА \",\n \"nameRu\": \"ИГРУШКА вязанная\",\n \"materialId\": 332,\n \"materialEn\": \"COTTON\",\n \"materialUa\": \"БАВОВНА\",\n \"materialRu\": \"Хлопок\",\n \"subMaterialId\": 333,\n \"subMaterialEn\": \"EMBROIDERED\",\n \"subMaterialUa\": \"ВИШИТИЙ\",\n \"subMaterialRu\": \"вышитый\",\n \"categoryId\": 8,\n \"categoryName\": \"Clothes & woven decor\",\n \"count\": 2\n }\n ]\n }\n }\n \"status\": \"success\"\n}"
tags:
- 'Orders FBM'
post:
summary: 'Update the specified order fbm resource.'
operationId: updateTheSpecifiedOrderFbmResource
description: ''
parameters: []
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n\"data\": [\n {\n \"order\": {\n \"id\": 143,\n \"receiverName\": \"receiverName\",\n \"recipientCompanyName\": \"recipientCompanyName\",\n \"createdAtStr\": \"2022-05-05 13:58:38\",\n \"receiverEmail\": \"receiverEmail@sdddd.dd\",\n \"receiverAddress\": \"receiverAddress\",\n \"receiverCity\": \"receiverCity\",\n \"receiverZip\": \"receiverZip\",\n \"receiverState\": \"receiverState\",\n \"receiverCountry\": \"Ukraine\",\n \"receiverPhone\": \"0989701676\",\n \"comment\": null,\n \"weightLb\": 11,\n \"weightOz\": 4,\n \"length\": 20,\n \"width\": 180,\n \"height\": 20,\n \"consolidationOrder\": false,\n \"skladCreateLabel\": true,\n \"shipDate\": {\n \"date\": \"2022-05-06 12:23:30.698958\",\n \"timezone_type\": 3,\n \"timezone\": \"Europe/Kiev\"\n },\n \"shippingCosts\": null,\n \"insurancesStatus\": false,\n \"insurances\": null,\n \"externalId\": \"1988820690\",\n \"storageId\" : 1,\n \"apiShipMethod\": \"1_1\",\n \"packagingId\": null,\n \"userPackType\": \"pack1\",\n \"status\": null,\n \"vatTaxId\": 81,\n \"transactionId\": null,\n \"productsData\": [],\n \"productsConsolidationData\": {\n \"content\": [\n {\n \"forSelectedId\": 4,\n \"forSelectedEn\": \"WOMENS\",\n \"forSelectedUa\": \"ЖІНОЧА\",\n \"forSelectedRu\": \"Женская\",\n \"nameId\": 328,\n \"nameEn\": \"TOY\",\n \"nameUa\": \"ІГРАШКА\",\n \"nameRu\": \"ИГРУШКА\",\n \"materialId\": 329,\n \"materialEn\": \"FELT\",\n \"materialUa\": \"ФЕТР\",\n \"materialRu\": \"фетр\",\n \"subMaterialId\": 330,\n \"subMaterialEn\": \"WOVEN\",\n \"subMaterialUa\": \"ТКАНИЙ \",\n \"subMaterialRu\": \"ТКАНЫЙ\",\n \"categoryId\": 8,\n \"categoryName\": \"Clothes & woven decor\",\n \"count\": 1\n },\n {\n \"forSelectedId\": 4,\n \"forSelectedEn\": \"WOMENS\",\n \"forSelectedUa\": \"ЖІНОЧА\",\n \"forSelectedRu\": \"Женская\",\n \"nameId\": 331,\n \"nameEn\": \"KNITTED WOVEN TOY\",\n \"nameUa\": \"ІГРАШКА В'ЯЗАНА \",\n \"nameRu\": \"ИГРУШКА вязанная\",\n \"materialId\": 332,\n \"materialEn\": \"COTTON\",\n \"materialUa\": \"БАВОВНА\",\n \"materialRu\": \"Хлопок\",\n \"subMaterialId\": 333,\n \"subMaterialEn\": \"EMBROIDERED\",\n \"subMaterialUa\": \"ВИШИТИЙ\",\n \"subMaterialRu\": \"вышитый\",\n \"categoryId\": 8,\n \"categoryName\": \"Clothes & woven decor\",\n \"count\": 2\n }\n ]\n },\n \"sendFrom\": {\n \"first_name\": \"test firstnam112222e\",\n \"last_name\": \"test lastname11\",\n \"company_name\": \"test companynam11e\",\n \"full_name\": \"test firstnam112222e test lastname11\",\n \"label\": \"test firstnam112222e test lastname11 test companynam11e\"\n },\n \"sendFromId\": \"9\"\n },\n },\n \"status\": \"success\"\n}"
tags:
- 'Orders FBM'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
receiverName:
type: required
description: 'string Receiver name'
example: rerum
recipientCompanyName:
type: required
description: 'string Receiver company name'
example: voluptatem
receiverEmail:
type: required
description: 'string Receiver email'
example: beahan.felicia@example.org
receiverPhone:
type: string
description: 'Receiver phone'
example: omnis
receiverAddress:
type: required
description: 'string Receiver address line 1'
example: sed
receiverAddress1:
type: string
description: 'Receiver address line 2'
example: dolor
receiverCity:
type: required
description: 'string Receiver city'
example: possimus
receiverZip:
type: required
description: 'string Receiver zip number'
example: laborum
receiverState:
type: required
description: 'string Receiver state'
example: sint
receiverCountry:
type: required
description: 'string Receiver country (Code iso 2)'
example: nisi
storageId:
type: integer
description: 'storage Id can get in route "https://system.skladusa.com/api/storage/order-fbm"'
example: 12
weightLb:
type: numeric
description: 'Weight in pound'
example: impedit
weightOz:
type: numeric
description: 'Weight in ounce'
example: non
length:
type: numeric
description: 'Length in sm'
example: deleniti
width:
type: numeric
description: 'Width in sm'
example: quasi
height:
type: numeric
description: 'Height in sm'
example: dolores
comment:
type: string
description: Comment
example: non
vatTaxId:
type: string
description: VATTAXID
example: velit
insurancesStatus:
type: boolean
description: 'Insurance? 0=No; 1=Yes'
example: false
insurances:
type: numeric
description: 'Insurance Amount'
example: non
transactionId:
type: number
description: ''
example: 1.101287
externalId:
type: string
description: 'External Id max lenth 256'
example: nihil
apiShipMethod:
type: string
description: 'Ship Method (999_999)'
example: rerum
packagingId:
type: string
description: 'External packaging Id'
example: cumque
consolidationOrder:
type: required
description: 'bool Consolidation order ? 0=No; 1=Yes'
example: molestiae
skladCreateLabel:
type: required
description: 'bool Sklad Create Label for order ? 0=No; 1=Yes'
example: quam
userPackType:
type: string
description: 'pack1 - Warehouse discretion, pack2 - Package, pack3 - Bubbles pack, pack4 - Carton'
example: recusandae
productsConsolidationData:
type: required
description: 'array Array or object productConsolidationType'
example: tempora
productsData:
type: array
description: 'This field is required when consolidationOrder is 0.'
example:
- quis
items:
type: integer
sendFromId:
type: int|null
description: 'Selected send from address id (може бути не вказано, у такому разі буде використаний перший з створених користувачем)'
example: ullam
'productsConsolidationData[][id]':
type: integer
description: 'Element id or null if new'
example: 13
'productsConsolidationData[][categoryId]':
type: required
description: 'integer Category Id'
example: in
'productsConsolidationData[][nameId]':
type: required
description: 'integer Name Id'
example: sed
'productsConsolidationData[][forSelectedId]':
type: integer
description: 'For Selected Id'
example: 9
'productsConsolidationData[][materialId]':
type: integer
description: 'Material Id'
example: 14
'productsConsolidationData[][subMaterialId]':
type: integer
description: 'SubMaterialId Id'
example: 1
'productsConsolidationData[][hsCode]':
type: string
description: HsCode
example: vero
'productsConsolidationData[][price]':
type: required
description: 'numeric Product Price'
example: rerum
'productsConsolidationData[][count]':
type: required
description: 'integer Product quantity'
example: aliquid
parameters:
-
in: path
name: id
description: 'The ID of the order.'
example: ducimus
required: true
schema:
type: string
-
in: path
name: orderFbmId
description: 'Optional parameter. Order Id.'
required: true
schema:
type: integer
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: 2
'/api/order/{id}/track':
get:
summary: 'Get tracking history by order id.'
operationId: getTrackingHistoryByOrderId
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
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
properties:
data:
type: object
properties:
message:
type: string
example: Delivered
history:
type: array
example:
- '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'
items:
type: string
trackingNumber:
type: string
example: '9400136109361359102933'
status:
type: string
example: success
tags:
- 'Orders FBM'
parameters:
-
in: path
name: id
description: 'The ID of the order.'
example: sit
required: true
schema:
type: string
-
in: path
name: orderFbmId
description: 'Optional parameter. Order Id.'
required: true
schema:
type: integer
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: 6
/api/rate/list:
post:
summary: 'Get Rate List for Order FBM'
operationId: getRateListForOrderFBM
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
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'
properties:
status:
type: string
example: success
data:
type: object
properties:
case:
type: object
properties:
fromCountry:
type: string
example: Ukraine
fromCountryCode:
type: string
example: UA
toCountry:
type: string
example: Germany
toCountryCode:
type: string
example: DE
stateCode:
type: string
example: null
zipCode:
type: string
example: '10179'
city:
type: string
example: Berlin
weight:
type: string
example: '1'
length:
type: string
example: '1'
width:
type: string
example: '1'
height:
type: string
example: '1'
clientPayPal:
type: boolean
example: true
shippingPrices:
type: object
properties:
currency:
type: string
example: USD
express:
type: array
example: []
consolidation:
type: array
example:
-
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'
items:
type: object
properties:
description:
type: string
example: 'DHLExpress, ExpressWorldwideNonDoc Parcel'
costs:
type: object
properties:
price:
type: string
example: '37.16'
fee:
type: integer
example: 2
apiShipMethod:
type: string
example: ExpressWorldwideNonDoc
tags:
- 'Orders FBM'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
senderCountryCode:
type: required
description: 'string Sender country code.'
example: adipisci
length:
type: required
description: 'string Length,sm.'
example: et
height:
type: required
description: 'string Height,sm.'
example: ut
width:
type: required
description: 'string Width,sm.'
example: laudantium
weight:
type: required
description: 'string Weight,kg.'
example: neque
countryCode:
type: required
description: 'string Country code.'
example: facilis
stateCode:
type: string
description: 'Need when Country code - US.'
example: ut
zipCode:
type: required
description: 'string Zip (postal) code.'
example: enim
city:
type: required
description: 'string City.'
example: fuga
clientPayPal:
type: required
description: 'boolean PayPal client.'
example: quae
'/api/order/{id}/set-shipstation-code':
post:
summary: 'Make label for order FBM'
operationId: makeLabelForOrderFBM
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
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'
properties:
status:
type: string
example: success
data:
type: object
properties:
id:
type: integer
example: 143
shipDate:
type: object
properties:
date:
type: string
example: '2022-05-06 14:40:00.000000'
timezone_type:
type: integer
example: 3
timezone:
type: string
example: Europe/Kiev
shippingCosts:
type: string
example: '9.01'
trackingNumber:
type: string
example: '9405536109361289955107'
label:
type: string
example: 'base64 file string'
tags:
- 'Orders FBM'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
serviceId:
type: required
description: 'string serviceId from delivery methods. Use /order/{id}/get-delivery-methods before.'
example: occaecati
parameters:
-
in: path
name: id
description: 'The ID of the order.'
example: molestias
required: true
schema:
type: string
-
in: path
name: orderFbmId
description: 'Optional parameter. Order Id.'
required: true
schema:
type: integer
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: 20
/api/gateway:
post:
summary: 'Get Authorize popup HTML'
operationId: getAuthorizePopupHTML
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: success
data: HTML
properties:
status:
type: string
example: success
data:
type: string
example: HTML
tags:
- 'Authorize Pay'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
sum:
type: required
description: 'string Pay Amount'
example: eaque
shopName:
type: required
description: 'string Shop name'
example: quis
orderId:
type: required
description: 'string Order Id'
example: voluptas
iframeUrl:
type: required
description: 'string iframe Url for authorize.net'
example: 'https://halvorson.com/suscipit-voluptas-consectetur-quasi-explicabo-qui.html'
callBackUrl:
type: required
description: 'string callBackUrl Url for site'
example: 'https://www.schoen.com/ut-dolorum-provident-asperiores-dolorum-tempora'
/api/storage/order-fbm:
post:
summary: 'Get possible Warehouse storage.'
operationId: getPossibleWarehouseStorage
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: 1
name: Blaine
status: success
properties:
data:
type: array
example:
-
id: 1
name: Blaine
items:
type: object
properties:
id:
type: integer
example: 1
name:
type: string
example: Blaine
status:
type: string
example: success
tags:
- WarehouseStorage
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
receiverCountry:
type: required
description: 'string Receiver country (Code iso 2)'
example: quibusdam
receiverZip:
type: required
description: 'string Receiver zip number'
example: itaque
consolidationOrder:
type: required
description: 'bool Consolidation order ? 0=No; 1=Yes'
example: placeat
skladCreateLabel:
type: required
description: 'bool Sklad Create Label for order ? 0=No; 1=Yes'
example: doloribus
/api/order/send-from:
get:
summary: 'Display a listing of the send from data.'
operationId: displayAListingOfTheSendFromData
description: ''
parameters: []
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n \"data\": {\n \"entities\": [\n {\n \"id\": 7,\n \"firstName\": \"test firstnam1e\",\n \"lastName\": \"test lastname1\",\n \"companyName\": \"test companynam1e\",\n \"fullName\": \"test firstnam1e test lastname1\",\n \"label\": \"test firstnam1e test lastname1 test companynam1e\"\n },\n ...\n ],\n \"pagination\": {\n \"last\": 1,\n \"current\": 0,\n \"numItemsPerPage\": 200,\n \"first\": 1,\n \"pageCount\": 1,\n \"totalCount\": 4,\n \"pageRange\": 1,\n \"startPage\": 1,\n \"endPage\": 1,\n \"previous\": 0,\n \"next\": 1,\n \"pagesInRange\": [\n 1\n ],\n \"firstPageInRange\": 1,\n \"lastPageInRange\": 1,\n \"currentItemCount\": 200,\n \"firstItemNumber\": 201,\n \"lastItemNumber\": 1\n }\n },\n \"status\": \"success\"\n }"
tags:
- 'OrderSend From'
post:
summary: 'Store the specified send from data.'
operationId: storeTheSpecifiedSendFromData
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
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'
properties:
status:
type: integer
example: 200
data:
type: object
properties:
id:
type: integer
example: 10
firstName:
type: string
example: 'test firstnam112222e'
lastName:
type: string
example: 'test lastname11s'
companyName:
type: string
example: 'test companynam11e'
fullName:
type: string
example: 'test firstnam112222e test lastname11s'
label:
type: string
example: 'test firstnam112222e test lastname11s test companynam11e'
tags:
- 'OrderSend From'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
firstName:
type: required
description: 'string Receiver name'
example: accusamus
lastName:
type: required
description: 'string Receiver company name'
example: accusantium
companyName:
type: required
description: 'string Receiver email'
example: facere
parameters:
-
in: path
name: page
description: 'Optional parameter. Current page default 1.'
required: true
schema:
type: integer
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: 20
tags:
-
name: Products
description: ''
-
name: 'Proform Data'
description: ''
-
name: 'Key Crm'
description: ''
-
name: Transactions
description: ''
-
name: 'Orders FBM'
description: ''
-
name: 'Authorize Pay'
description: ''
-
name: WarehouseStorage
description: ''
-
name: 'OrderSend From'
description: ''