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: repellat title: type: string description: 'Dusty blue white flower comb Bride Bridesmaid floral hair piece Fall wedding hair accessories' example: laudantium upc: type: string description: B073QK9LZX example: velit sku: type: string description: 'B072KG8H4M, BT-F10M-HAER' example: libero 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: facere title: type: string description: 'Dusty blue white flower comb Bride Bridesmaid floral hair piece Fall wedding hair accessories' example: est upc: type: string description: B073QK9LZX example: recusandae sku: type: string description: 'B072KG8H4M, BT-F10M-HAER' example: repellendus productPacketType: type: boolean description: '(0 | 1)' example: true required: - name - title - upc - sku - productPacketType security: [] parameters: - in: path name: id description: 'The ID of the product.' example: ut 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: 12 /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: 11 - 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: 20 '/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: eum 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: 11 /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: 12 materialId: type: integer description: 'Proform Data material Id' example: 2 /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: 'John Smith' receiverEmail: support@skladusa.com receiverPhone: '+380 971112233' receiverAddress: 'вулиця Перемоги' receiverCity: Житомир receiverZip: '10000' receiverState: 'Житомирська область' receiverCountry: null weightLb: null weightOz: null length: null width: null height: null comment: null insurancesStatus: null insurances: null externalId: null apiShipMethod: null packagingId: null consolidationOrder: true skladCreateLabel: false userPackType: null productsData: null productsConsolidationData: - descrEn: 'test listing' count: 1 transactionId: 24234 order: id: 584 receiverName: 'John Smith' createdAtStr: '2022-05-24 15:30:17' receiverEmail: 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: 'John Smith' receiverEmail: type: string example: support@skladusa.com receiverPhone: type: string example: '+380 971112233' 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: 'John Smith' 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: amet - 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: temporibus - 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: maxime /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: autem length: type: required description: 'string Length,sm.' example: corporis height: type: required description: 'string Height,sm.' example: corrupti width: type: required description: 'string Width,sm.' example: error weight: type: required description: 'string Weight,kg.' example: qui countryCode: type: required description: 'string Country code.' example: quasi stateCode: type: string description: 'Need when Country code - US.' example: exercitationem zipCode: type: required description: 'string Zip (postal) code.' example: omnis city: type: required description: 'string City.' example: nulla clientPayPal: type: required description: 'boolean PayPal client.' example: amet /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: 6 - 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/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: 4 '/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: nisi parameters: - in: path name: id description: 'The ID of the transaction.' example: neque 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: 16 '/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: autem 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: 16 /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: qui recipientCompanyName: type: required description: 'string Receiver company name' example: illo receiverEmail: type: required description: 'string Receiver email' example: acruickshank@example.com receiverPhone: type: string description: 'Receiver phone' example: ut receiverAddress: type: required description: 'string Receiver address line 1' example: nesciunt receiverAddress1: type: string description: 'Receiver address line 2' example: quisquam receiverCity: type: required description: 'string Receiver city' example: sit receiverZip: type: required description: 'string Receiver zip number' example: praesentium receiverState: type: required description: 'string Receiver state' example: qui receiverCountry: type: required description: 'string Receiver country (Code iso 2)' example: qui storageId: type: integer description: 'storage Id can get in route "https://system.skladusa.com/api/storage/order-fbm"' example: 9 weightLb: type: numeric description: 'Weight in pound' example: voluptate weightOz: type: numeric description: 'Weight in ounce' example: placeat length: type: numeric description: 'Length in sm' example: et width: type: numeric description: 'Width in sm' example: et height: type: numeric description: 'Height in sm' example: excepturi comment: type: string description: Comment example: quam vatTaxId: type: string description: VATTAXID example: dolor insurancesStatus: type: boolean description: 'Insurance? 0=No; 1=Yes' example: false insurances: type: numeric description: 'Insurance Amount' example: quia transactionId: type: number description: '' example: 600726.36 externalId: type: string description: 'External Id max lenth 256' example: sed apiShipMethod: type: string description: 'Ship Method (999_999)' example: aliquam packagingId: type: string description: 'External packaging Id' example: ut consolidationOrder: type: required description: 'bool Consolidation order ? 0=No; 1=Yes' example: id skladCreateLabel: type: required description: 'bool Sklad Create Label for order ? 0=No; 1=Yes' example: autem userPackType: type: string description: 'pack1 - Warehouse discretion, pack2 - Package, pack3 - Bubbles pack, pack4 - Carton' example: est productsConsolidationData: type: required description: 'array Array or object productConsolidationType' example: sit productsData: type: array description: 'This field is required when consolidationOrder is 0.' example: - quidem items: type: integer sendFromId: type: int|null description: 'Selected send from address id (може бути не вказано, у такому разі буде використаний перший з створених користувачем)' example: autem 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: 15 - 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: 17 /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: accusantium 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/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: minima recipientCompanyName: type: required description: 'string Receiver company name' example: error receiverEmail: type: required description: 'string Receiver email' example: champlin.montana@example.org receiverPhone: type: string description: 'Receiver phone' example: quibusdam receiverAddress: type: required description: 'string Receiver address line 1' example: amet receiverAddress1: type: string description: 'Receiver address line 2' example: quia receiverCity: type: required description: 'string Receiver city' example: deserunt receiverZip: type: required description: 'string Receiver zip number' example: numquam receiverState: type: required description: 'string Receiver state' example: quis receiverCountry: type: required description: 'string Receiver country (Code iso 2)' example: laborum storageId: type: integer description: 'storage Id can get in route "https://system.skladusa.com/api/storage/order-fbm"' example: 2 weightLb: type: numeric description: 'Weight in pound' example: consequatur weightOz: type: numeric description: 'Weight in ounce' example: libero length: type: numeric description: 'Length in sm' example: ut width: type: numeric description: 'Width in sm' example: nostrum height: type: numeric description: 'Height in sm' example: eaque comment: type: string description: Comment example: et vatTaxId: type: string description: VATTAXID example: rem insurancesStatus: type: boolean description: 'Insurance? 0=No; 1=Yes' example: false insurances: type: numeric description: 'Insurance Amount' example: debitis transactionId: type: number description: '' example: 52.94466 externalId: type: string description: 'External Id max lenth 256' example: laudantium apiShipMethod: type: string description: 'Ship Method (999_999)' example: et packagingId: type: string description: 'External packaging Id' example: voluptas consolidationOrder: type: required description: 'bool Consolidation order ? 0=No; 1=Yes' example: aut skladCreateLabel: type: required description: 'bool Sklad Create Label for order ? 0=No; 1=Yes' example: et userPackType: type: string description: 'pack1 - Warehouse discretion, pack2 - Package, pack3 - Bubbles pack, pack4 - Carton' example: delectus productsConsolidationData: type: required description: 'array Array or object productConsolidationType' example: nesciunt productsData: type: array description: 'This field is required when consolidationOrder is 0.' example: - rerum items: type: integer sendFromId: type: int|null description: 'Selected send from address id (може бути не вказано, у такому разі буде використаний перший з створених користувачем)' example: voluptate 'productsConsolidationData[][id]': type: integer description: 'Element id or null if new' example: 11 'productsConsolidationData[][categoryId]': type: required description: 'integer Category Id' example: molestias 'productsConsolidationData[][nameId]': type: required description: 'integer Name Id' example: enim 'productsConsolidationData[][forSelectedId]': type: integer description: 'For Selected Id' example: 9 'productsConsolidationData[][materialId]': type: integer description: 'Material Id' example: 5 'productsConsolidationData[][subMaterialId]': type: integer description: 'SubMaterialId Id' example: 7 'productsConsolidationData[][hsCode]': type: string description: HsCode example: sint 'productsConsolidationData[][price]': type: required description: 'numeric Product Price' example: ut 'productsConsolidationData[][count]': type: required description: 'integer Product quantity' example: deleniti parameters: - in: path name: id description: 'The ID of the order.' example: ea 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: 19 '/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: culpa 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: 7 /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: quaerat length: type: required description: 'string Length,sm.' example: fuga height: type: required description: 'string Height,sm.' example: voluptates width: type: required description: 'string Width,sm.' example: nemo weight: type: required description: 'string Weight,kg.' example: sapiente countryCode: type: required description: 'string Country code.' example: reiciendis stateCode: type: string description: 'Need when Country code - US.' example: accusantium zipCode: type: required description: 'string Zip (postal) code.' example: molestiae city: type: required description: 'string City.' example: qui clientPayPal: type: required description: 'boolean PayPal client.' example: quia '/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: blanditiis parameters: - in: path name: id description: 'The ID of the order.' example: fuga 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: 15 /api/express-orders/dictionaries: get: summary: 'Dictionaries for express order form.' operationId: dictionariesForExpressOrderForm description: '' parameters: [] responses: 200: description: '' content: text/plain: schema: type: string example: "{\n \"status\": \"success\",\n \"data\": {\n \"countries\": [\n \"id\": 3,\n \"label\": \"Algeria\",\n \"currencies\": [],\n \"regions\": [],\n ],\n \"proformTypes\": [\n ...\n ]\n }\n}" tags: - 'Orders Express' /api/express-orders/get-npg-warehouse-list: get: summary: 'Get NovaPoshtaGlobal warehouse list from customer profile.' operationId: getNovaPoshtaGlobalWarehouseListFromCustomerProfile description: '' parameters: [] responses: 200: description: '' content: text/plain: schema: type: string example: "{\n \"status\": \"success\",\n \"data\": [\n {\n \"address_type\": \"Warehouse\",\n \"ref_warehouse\": \"1611283d-e1c2-11e3-8c4a-4588968002cf\",\n \"warehouse_name\": \"Київ, Київська, Відділення №18...\",\n \"city_name\": \"Київ, Київська\"\n },\n ...\n ]\n}" tags: - 'Orders Express' '/api/express-orders/find-city-for-npg/{query}/{countryCode}': get: summary: 'Search cities for NovaPoshtaGlobal.' operationId: searchCitiesForNovaPoshtaGlobal description: '' parameters: [] responses: 200: description: '' content: application/json: schema: type: object example: status: success data: - label: 'Київ, Київська' - label: 'Київець, Львівська' properties: status: type: string example: success data: type: array example: - label: 'Київ, Київська' - label: 'Київець, Львівська' items: type: object properties: label: type: string example: 'Київ, Київська' tags: - 'Orders Express' parameters: - in: path name: query description: '' example: laboriosam required: true schema: type: string - in: path name: countryCode description: 'Optional parameter.' required: true schema: type: string examples: omitted: summary: 'When the value is omitted' value: '' present: summary: 'When the value is present' value: perspiciatis '/api/express-orders/warehouses-by-city-for-npg/{query}/{countryCode}': get: summary: 'Search warehouses for NovaPoshtaGlobal by City.' operationId: searchWarehousesForNovaPoshtaGlobalByCity description: '' parameters: [] responses: 200: description: '' content: text/plain: schema: type: string example: "{\n \"status\": \"success\",\n \"data\": [\n [\n {\n \"reference\": \"1ec09d6b-e1c2-11e3-8c4a-0050568002cf\",\n \"currentTranslate\": {\n \"name\": \"Kyiv, Kyivska, Viddilennia №7...\",\n \"city\": \"Kyiv, Kyivska\"\n },\n },\n ...\n ]\n ]\n}" tags: - 'Orders Express' parameters: - in: path name: query description: '' example: quaerat required: true schema: type: string - in: path name: countryCode description: 'Optional parameter.' required: true schema: type: string examples: omitted: summary: 'When the value is omitted' value: '' present: summary: 'When the value is present' value: magni '/api/express-orders/{id}': get: summary: 'Display the specified order express resource.' operationId: displayTheSpecifiedOrderExpressResource description: '' parameters: [] responses: 200: description: '' content: text/plain: schema: type: string example: "{\n\"data\": {\n \"id\": 143,\n ...\n },\n \"status\": \"success\"\n}" tags: - 'Orders Express' parameters: - in: path name: id description: 'The ID of the express order.' example: rerum required: true schema: type: string - in: path name: orderExpressId 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: 13 '/api/express-orders/{id}/tracking-history': 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 Express' parameters: - in: path name: id description: 'The ID of the express 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: 18 /api/express-orders/npg-price: post: summary: 'Get Shipping Delivery Price from NPG Api.' operationId: getShippingDeliveryPriceFromNPGApi description: '' parameters: [] responses: 200: description: '' content: application/json: schema: type: object example: status: 200 data: price_variant: - price: 36.63 orderFee: 0 total_price: 36.63 oversize_charge: 0 initial_price: 0 additional_handling_surcharge: 0 out_of_delivery.extra_charge: 0 out_of_delivery.shipping_cost: 0 label: Cargo delivery_service_type: '29:cargo' properties: status: type: integer example: 200 data: type: object properties: price_variant: type: array example: - price: 36.63 orderFee: 0 total_price: 36.63 oversize_charge: 0 initial_price: 0 additional_handling_surcharge: 0 out_of_delivery.extra_charge: 0 out_of_delivery.shipping_cost: 0 label: Cargo delivery_service_type: '29:cargo' items: type: object properties: price: type: number example: 36.63 orderFee: type: integer example: 0 total_price: type: number example: 36.63 oversize_charge: type: integer example: 0 initial_price: type: integer example: 0 additional_handling_surcharge: type: integer example: 0 out_of_delivery.extra_charge: type: integer example: 0 out_of_delivery.shipping_cost: type: integer example: 0 label: type: string example: Cargo delivery_service_type: type: string example: '29:cargo' tags: - 'Orders Express' requestBody: required: true content: application/json: schema: type: object properties: warehouse_id: type: integer description: '' example: 8 payment_transaction_id: type: integer description: '' example: 13 sender: type: array description: 'Order Express country_code,city,post_code' example: - quibusdam items: type: string recipient: type: array description: 'Order Express country_code,city,post_code' example: - inventore items: type: string products: type: array description: 'Order Express product data' example: - aut items: type: string proform_packaging: type: array description: 'Order Express proform packaging data' example: - nesciunt items: type: string insurance_amount: type: numeric description: 'Order Express insurance_amount data' example: in for_consolidation: type: boolean description: '' example: false required: - sender - recipient - products - proform_packaging - insurance_amount /api/express-orders/make-label: post: summary: 'Creation label for express order.' operationId: creationLabelForExpressOrder description: '' parameters: [] responses: 200: description: '' content: application/json: schema: type: object example: status: 200 data: status: true properties: status: type: integer example: 200 data: type: object properties: status: type: boolean example: true tags: - 'Orders Express' requestBody: required: true content: application/json: schema: type: object properties: order_express_id: type: integer description: 'Order express id' example: 17 delivery_service_type: type: string description: 'Must not be greater than 255 characters.' example: ymdopxluqtvnbfd required: - order_express_id '/api/express-orders/get-file/{uuid}': get: summary: 'Get file by uuid.' operationId: getFileByUuid description: '' parameters: [] responses: 200: description: '' content: text/plain: schema: type: string example: "{\n Файл в ответе\n}" tags: - 'Orders Express' parameters: - in: path name: uuid description: 'Optional parameter. required. uuid файла.' required: true schema: type: string examples: omitted: summary: 'When the value is omitted' value: '' present: summary: 'When the value is present' value: 8671905b-ed89-3a8b-b193-63ba97f196fa /api/express-orders: put: summary: 'Create new express order for NovaPoshtaGlobal.' operationId: createNewExpressOrderForNovaPoshtaGlobal description: '' parameters: [] responses: 200: description: '' content: text/plain: schema: type: string example: "{\n \"status\": \"success\",\n \"data\": {\n \"id\": 3680,\n ...\n }\n}," tags: - 'Orders Express' requestBody: required: true content: application/json: schema: type: object properties: total_order_amount: type: number description: '' example: 2982.17760409 from_model: type: string description: '' example: from_payment_transaction enum: - from_order_external - from_payment_transaction model_id: type: integer description: '' example: 19 delivery_service_id: type: integer description: '' example: 8 status: type: string description: '' example: wait_for_pay enum: - completed - in_progress - copy - wait_for_pay - wait_for_making_label send_type: type: string description: '' example: by_himself enum: - by_himself - by_warehouse warehouse_id: type: integer description: 'This field is required when send_type is by_warehouse.' example: 17 new_post_tracking_number: type: string description: 'Must not be greater than 255 characters.' example: vhlkkhyue tracking_number: type: string description: '' example: vel sender_contact_name: type: string description: 'This field is required when send_type is by_himself. Must not be greater than 255 characters.' example: wbqzz sender_phone_number: type: string description: 'This field is required when send_type is by_himself.' example: libero recipient_contact_name: type: string description: 'Must not be greater than 255 characters.' example: fqs recipient_phone_number: type: string description: 'Must match the regex /^(\+)?[\s\d-]+(ext.\s\d{3,})?$/im.' example: '-extps2{3,}$/im' recipient_email: type: string description: 'Must be a valid email address. Must not be greater than 255 characters.' example: gottlieb.rene@example.org recipient_address: type: string description: 'Must not be greater than 255 characters.' example: vdrutudk recipient_additional_address: type: string description: 'Must not be greater than 255 characters.' example: ow recipient_city: type: string description: 'Must not be greater than 255 characters.' example: imthtcs recipient_region: type: string description: 'Must not be greater than 255 characters.' example: ueqwysoakzfchelxkagewvmp recipient_country_id: type: integer description: '' example: 13 recipient_zip_code: type: string description: 'Must not be greater than 255 characters.' example: eblulfjytxqhegcltbxzz recipient_currency_id: type: integer description: '' example: 15 delivery_date: type: string description: 'Must match the regex /\d{4}-\d{2}-\d{2}$/i.' example: 3747-78-38$/i available_courier_time: type: string description: 'Must match the regex /\d{2}:\d{2}\|\d{2}:\d{2}$/i.' example: '76:74|30:47$/i' not_available_courier_time: type: string description: 'Must match the regex /\d{2}:\d{2}\|\d{2}:\d{2}$/i.' example: '94:11|59:05$/i' vat_number: type: string description: 'Must not be greater than 255 characters.' example: gcnxeipfd deleted_proform_ids: type: object description: '' example: null properties: proform_data: type: array description: '' example: - 2 items: type: integer proform_data: type: array description: '' example: - quisquam items: type: integer proform_packaging: type: object description: '' example: [] properties: package_name: type: string description: 'Must not be greater than 255 characters.' example: rtexh weight: type: number description: '' example: 3054.3157 length: type: number description: '' example: 20000021.276468 width: type: number description: '' example: 2749527.9593332 height: type: number description: '' example: 0.64394 insurance_amount: type: number description: '' example: 7.13839 packaging_type: type: string description: '' example: fedex_envelope_packaging enum: - himself_packaging - fedex_packaging - fedex_envelope_packaging drop_certification: type: boolean description: 'This field is required when delivery_service_id is 2.' example: false toxic_substance: type: boolean description: 'This field is required when delivery_service_id is 2.' example: false freight_cost: type: number description: '' example: 267.698098 in_draft: type: integer description: '' example: '0' enum: - '0' - '1' courier_arrival_date: type: string description: 'Must match the regex /\d{4}-\d{2}-\d{2}$/i.' example: 1884-71-26$/i courier_from_to_time: type: string description: 'Must match the regex /\d{2}:\d{2}\|\d{2}:\d{2}$/i.' example: '52:17|89:14$/i' courier_contact_name: type: string description: 'Must not be greater than 255 characters.' example: sydawerkowgoxrpfwhmaub courier_contact_phone: type: string description: 'Must not be greater than 255 characters.' example: bhvwreydgwsqtkjloqvi sender_contact_address: type: string description: '' example: accusamus alarm_status: type: boolean description: '' example: false order_express_country_type: type: string description: '' example: null delivery_service_type: type: string description: 'Must not be greater than 255 characters.' example: iyzaoy npg: type: object description: '' example: null properties: address_type: type: string description: '' example: null ref_warehouse: type: string description: '' example: null warehouse_name: type: string description: '' example: null city_name: type: string description: '' example: null required: - delivery_service_id - send_type - recipient_contact_name - recipient_phone_number - recipient_address - recipient_city - recipient_region - recipient_country_id - recipient_zip_code - delivery_date - proform_data get: summary: 'Display a listing of the order express.' operationId: displayAListingOfTheOrderExpress description: '' parameters: [] responses: 200: description: '' content: text/plain: schema: type: string example: "{\n \"data\": {\n \"entities\": [\n {\n \"id\": 3666,\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 Express' /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: doloremque shopName: type: required description: 'string Shop name' example: eveniet orderId: type: required description: 'string Order Id' example: ullam iframeUrl: type: required description: 'string iframe Url for authorize.net' example: 'https://www.grant.org/et-ad-facere-et-nulla-perferendis-nihil-temporibus-aut' callBackUrl: type: required description: 'string callBackUrl Url for site' example: 'http://hettinger.com/earum-magnam-veniam-voluptates-aut-ipsum-fuga.html' /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: necessitatibus receiverZip: type: required description: 'string Receiver zip number' example: natus consolidationOrder: type: required description: 'bool Consolidation order ? 0=No; 1=Yes' example: magnam skladCreateLabel: type: required description: 'bool Sklad Create Label for order ? 0=No; 1=Yes' example: ut /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: iusto lastName: type: required description: 'string Receiver company name' example: aut companyName: type: required description: 'string Receiver email' example: vitae 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 tags: - name: Products description: '' - name: 'Proform Data' description: '' - name: 'Key Crm' description: '' - name: Transactions description: '' - name: 'Orders FBM' description: '' - name: 'Orders Express' description: '' - name: 'Authorize Pay' description: '' - name: WarehouseStorage description: '' - name: 'OrderSend From' description: ''