openapi: 3.0.3 info: title: 'Api documentation for SKLAD USA' description: '' version: 1.0.0 servers: - url: 'https://system.skladusa.com' paths: /api/gateway: post: summary: 'Get Authorize popup HTML' description: '' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string - in: header name: Authorization description: '' example: "required Basic + base64 encoded 'user_id:api_token'" schema: type: string 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: suscipit orderId: type: required description: 'string Order Id' example: aut iframeUrl: type: required description: 'string iframe Url for authorize.net' example: dolor callBackUrl: type: required description: 'string callBackUrl Url for site' example: aut shopName: type: required description: 'string Shop name' example: eveniet /api/key-crm/rate/list: post: summary: 'Get Rate List for Key Crm' description: '' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string - in: header name: Authorization description: '' example: "required Basic + base64 encoded 'user_id:api_token'" schema: type: string 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 example: 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' tags: - 'Key Crm' requestBody: required: false content: application/json: schema: type: object properties: senderCountryCode: type: required description: 'string Sender country code.' example: itaque length: type: required description: 'string Length,sm.' example: facilis height: type: required description: 'string Height,sm.' example: sint width: type: required description: 'string Width,sm.' example: et weight: type: required description: 'string Weight,kg.' example: delectus countryCode: type: required description: 'string Country code.' example: id stateCode: type: string description: 'Need when Country code - US.' example: qui zipCode: type: required description: 'string Zip (postal) code.' example: qui city: type: required description: 'string City.' example: nisi clientPayPal: type: required description: 'boolean PayPal client.' example: non /api/key-crm/create-order: get: summary: 'Prepare order data for Key Crm.' description: '' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string - in: header name: Authorization description: '' example: "required Basic + base64 encoded 'user_id:api_token'" schema: type: string 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 example: 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: type: object example: 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: type: object example: gross: 2 ppFee: 0.38 skladUsaFee: 0.03 sum: 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: iure - 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: et - 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: aut /api/order: get: summary: 'Display a listing of the order fbm data.' description: '' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string - in: header name: Authorization description: '' example: "required Basic + base64 encoded 'user_id:api_token'" schema: type: string 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 }\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.' description: '' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string - in: header name: Authorization description: '' example: "required Basic + base64 encoded 'user_id:api_token'" schema: type: string 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 },\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: occaecati recipientCompanyName: type: required description: 'string Receiver company name' example: et receiverEmail: type: required description: 'string Receiver email' example: fuga receiverPhone: type: string description: 'Receiver phone' example: optio receiverAddress: type: required description: 'string Receiver address line 1' example: aliquid receiverAddress1: type: string description: 'Receiver address line 2' example: libero receiverCity: type: required description: 'string Receiver city' example: illum receiverZip: type: required description: 'string Receiver zip number' example: quos receiverState: type: required description: 'string Receiver state' example: repellendus receiverCountry: type: required description: 'string Receiver country (Code iso 2)' example: rem storageId: type: integer description: 'storage Id can get in route "https://system.skladusa.com/api/storage/order-fbm"' example: 8 weightLb: type: numeric description: 'Weight in pound' example: ducimus weightOz: type: numeric description: 'Weight in ounce' example: et length: type: numeric description: 'Length in sm' example: placeat width: type: numeric description: 'Width in sm' example: praesentium height: type: numeric description: 'Height in sm' example: ratione comment: type: string description: Comment example: voluptates vatTaxId: type: string description: VATTAXID example: eius insurancesStatus: type: boolean description: 'Insurance? 0=No; 1=Yes' example: false insurances: type: numeric description: 'Insurance Amount' example: sint transactionId: type: number description: '' example: 108210.7 externalId: type: string description: 'External Id max lenth 256' example: alias apiShipMethod: type: string description: 'Ship Method (999_999)' example: soluta packagingId: type: string description: 'External packaging Id' example: ut consolidationOrder: type: required description: 'bool Consolidation order ? 0=No; 1=Yes' example: dolorem skladCreateLabel: type: required description: 'bool Sklad Create Label for order ? 0=No; 1=Yes' example: ex userPackType: type: string description: 'pack1 - Warehouse discretion, pack2 - Package, pack3 - Bubbles pack, pack4 - Carton' example: deleniti productsConsolidationData: type: required description: 'array Array or object productConsolidationType' example: et productsData: type: array description: '' example: - [] items: type: object properties: product: type: required description: 'integer Product product_id' example: '2321' hsCode: type: optional description: 'string Product hs_code' example: 324325SDA.001 price: type: numeric description: 'Product item_price' example: '3.09' description: type: required description: 'integer Product item_description' example: 'Product description text for int.' count: type: required description: 'numeric Product quantity' example: '2' 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: 2 /api/order/example: get: summary: 'Display example of the order fbm body response.' description: '' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string - in: header name: Authorization description: '' example: "required Basic + base64 encoded 'user_id:api_token'" schema: type: string 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 tags: - 'Orders FBM' /api/shipping-method: get: summary: 'Display a listing of the shipping methods.' description: '' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string - in: header name: Authorization description: '' example: "required Basic + base64 encoded 'user_id:api_token'" schema: type: string 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 example: 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: type: string example: success tags: - 'Orders FBM' '/api/order/{id}/get-delivery-methods': get: summary: 'Display the delivery methods for order fbm resource.' description: '' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string - in: header name: Authorization description: '' example: "required Basic + base64 encoded 'user_id:api_token'" schema: type: string 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 tags: - 'Orders FBM' parameters: - in: path name: id description: 'The ID of the order.' example: reiciendis 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: 13 /api/user-pack-type: get: summary: 'Display a listing of the packing types.' description: '' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string - in: header name: Authorization description: '' example: "required Basic + base64 encoded 'user_id:api_token'" schema: type: string 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 status: type: string example: success tags: - 'Orders FBM' /api/packaging-type: get: summary: 'Get packing type price list for order.' description: '' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string - in: header name: Authorization description: '' example: "required Basic + base64 encoded 'user_id:api_token'" schema: type: string 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 example: 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: type: string example: success tags: - 'Orders FBM' '/api/order/{id}': get: summary: 'Display the specified order fbm resource.' description: '' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string - in: header name: Authorization description: '' example: "required Basic + base64 encoded 'user_id:api_token'" schema: type: string 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.' description: '' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string - in: header name: Authorization description: '' example: "required Basic + base64 encoded 'user_id:api_token'" schema: type: string 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 },\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: dignissimos recipientCompanyName: type: required description: 'string Receiver company name' example: aut receiverEmail: type: required description: 'string Receiver email' example: eaque receiverPhone: type: string description: 'Receiver phone' example: odio receiverAddress: type: required description: 'string Receiver address line 1' example: et receiverAddress1: type: string description: 'Receiver address line 2' example: vero receiverCity: type: required description: 'string Receiver city' example: cumque receiverZip: type: required description: 'string Receiver zip number' example: ex receiverState: type: required description: 'string Receiver state' example: odit receiverCountry: type: required description: 'string Receiver country (Code iso 2)' example: voluptas storageId: type: integer description: 'storage Id can get in route "https://system.skladusa.com/api/storage/order-fbm"' example: 10 weightLb: type: numeric description: 'Weight in pound' example: voluptatem weightOz: type: numeric description: 'Weight in ounce' example: adipisci length: type: numeric description: 'Length in sm' example: voluptatem width: type: numeric description: 'Width in sm' example: consequatur height: type: numeric description: 'Height in sm' example: dignissimos comment: type: string description: Comment example: consequatur vatTaxId: type: string description: VATTAXID example: fugit insurancesStatus: type: boolean description: 'Insurance? 0=No; 1=Yes' example: false insurances: type: numeric description: 'Insurance Amount' example: ut transactionId: type: number description: '' example: 413.57574 externalId: type: string description: 'External Id max lenth 256' example: voluptatem apiShipMethod: type: string description: 'Ship Method (999_999)' example: corporis packagingId: type: string description: 'External packaging Id' example: facilis consolidationOrder: type: required description: 'bool Consolidation order ? 0=No; 1=Yes' example: dolores skladCreateLabel: type: required description: 'bool Sklad Create Label for order ? 0=No; 1=Yes' example: blanditiis userPackType: type: string description: 'pack1 - Warehouse discretion, pack2 - Package, pack3 - Bubbles pack, pack4 - Carton' example: distinctio productsConsolidationData: type: required description: 'array Array or object productConsolidationType' example: est productsData: type: array description: '' example: - [] items: type: object properties: product: type: integer description: '' example: 9 hsCode: type: string description: '' example: perspiciatis price: type: number description: '' example: 0.0 description: type: string description: '' example: expedita count: type: integer description: 'Must be at least 1.' example: 1 required: - product - count 'productsConsolidationData[][id]': type: integer description: 'Element id or null if new' example: 9 'productsConsolidationData[][categoryId]': type: required description: 'integer Category Id' example: et 'productsConsolidationData[][nameId]': type: required description: 'integer Name Id' example: ea 'productsConsolidationData[][forSelectedId]': type: integer description: 'For Selected Id' example: 15 'productsConsolidationData[][materialId]': type: integer description: 'Material Id' example: 4 'productsConsolidationData[][subMaterialId]': type: integer description: 'SubMaterialId Id' example: 1 'productsConsolidationData[][hsCode]': type: string description: HsCode example: quo 'productsConsolidationData[][price]': type: required description: 'numeric Product Price' example: est 'productsConsolidationData[][count]': type: required description: 'integer Product quantity' example: consectetur parameters: - in: path name: id description: 'The ID of the order.' example: et 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: 11 '/api/order/{id}/track': get: summary: 'Get tracking history by order id.' description: '' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string - in: header name: Authorization description: '' example: "required Basic + base64 encoded 'user_id:api_token'" schema: type: string 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 example: 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: type: string example: success tags: - 'Orders FBM' parameters: - in: path name: id description: 'The ID of the order.' example: totam 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: 5 /api/rate/list: post: summary: 'Get Rate List for Order FBM' description: '' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string - in: header name: Authorization description: '' example: "required Basic + base64 encoded 'user_id:api_token'" schema: type: string 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 example: 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' tags: - 'Orders FBM' requestBody: required: false content: application/json: schema: type: object properties: senderCountryCode: type: required description: 'string Sender country code.' example: a length: type: required description: 'string Length,sm.' example: numquam height: type: required description: 'string Height,sm.' example: aut width: type: required description: 'string Width,sm.' example: quia weight: type: required description: 'string Weight,kg.' example: et countryCode: type: required description: 'string Country code.' example: maiores stateCode: type: string description: 'Need when Country code - US.' example: excepturi zipCode: type: required description: 'string Zip (postal) code.' example: quo city: type: required description: 'string City.' example: qui clientPayPal: type: required description: 'boolean PayPal client.' example: porro '/api/order/{id}/set-shipstation-code': post: summary: 'Make label for order FBM' description: '' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string - in: header name: Authorization description: '' example: "required Basic + base64 encoded 'user_id:api_token'" schema: type: string 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 example: 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' 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: quae parameters: - in: path name: id description: 'The ID of the order.' example: in 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: 11 /api/product: get: summary: 'Display a listing of the products.' description: '' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string - in: header name: Authorization description: '' example: "required Basic + base64 encoded 'user_id:api_token'" schema: type: string 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.' description: '' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string - in: header name: Authorization description: '' example: "required Basic + base64 encoded 'user_id:api_token'" schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: data: id: 87 status: success properties: data: type: object example: id: 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: consequatur 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: eum sku: type: string description: 'B072KG8H4M, BT-F10M-HAER' example: reiciendis required: - name - title - upc - sku security: [] '/api/product/{id}': get: summary: 'Display the specified product resource.' description: '' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string - in: header name: Authorization description: '' example: "required Basic + base64 encoded 'user_id:api_token'" schema: type: string 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 example: product: id: 85 name: 'Monica Panek' title: 'Monica Panek' upc: 'Monica Panek' sku: 'Monica Panek2' productPacketType: 0 status: type: string example: success tags: - Products security: [] post: summary: 'Update the specified product resource in storage.' description: '' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string - in: header name: Authorization description: '' example: "required Basic + base64 encoded 'user_id:api_token'" schema: type: string 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: quasi title: type: string description: 'Dusty blue white flower comb Bride Bridesmaid floral hair piece Fall wedding hair accessories' example: ut upc: type: string description: B073QK9LZX example: dolorem sku: type: string description: 'B072KG8H4M, BT-F10M-HAER' example: cupiditate 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: commodi 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: 7 /api/proforma-data/category: get: summary: 'Display a listing of the proform data.' description: '' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string - in: header name: Authorization description: '' example: "required Basic + base64 encoded 'user_id:api_token'" schema: type: string 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: 18 - 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/proforma-data/category/{id}': get: summary: 'Display the specified proform data resource.' description: '' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string - in: header name: Authorization description: '' example: "required Basic + base64 encoded 'user_id:api_token'" schema: type: string 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: maiores 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: 10 /api/proforma-data/hs-code: post: summary: 'Search Hs Code by proform options (name_id, material_id)' description: '' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string - in: header name: Authorization description: '' example: "required Basic + base64 encoded 'user_id:api_token'" schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: data: hsCode: oo1430NSOVmFUieS status: success properties: data: type: object example: hsCode: 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: 14 materialId: type: integer description: 'Proform Data material Id' example: 17 /api/transactions: get: summary: 'Display a listing of the user transactions.' description: '' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string - in: header name: Authorization description: '' example: "required Basic + base64 encoded 'user_id:api_token'" schema: type: string 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: 2 - 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: 13 '/api/transactions/{id}': get: summary: 'Display the specified transaction.' description: '' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string - in: header name: Authorization description: '' example: "required Basic + base64 encoded 'user_id:api_token'" schema: type: string 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 example: 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: 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: 1 '/api/transactions/{id}/update-tracking-number': post: summary: 'Send tracking number to payment system' description: '' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string - in: header name: Authorization description: '' example: "required Basic + base64 encoded 'user_id:api_token'" schema: type: string 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: velit parameters: - in: path name: id description: 'The ID of the transaction.' example: esse 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: 5 '/api/transactions/{id}/create-order': get: summary: 'Prepare form for creating order from payment transaction' description: '' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string - in: header name: Authorization description: '' example: "required Basic + base64 encoded 'user_id:api_token'" schema: type: string 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 example: 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: type: string example: null tags: - Transactions parameters: - in: path name: id description: 'The ID of the transaction.' example: commodi 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: 15 /api/storage/order-fbm: post: summary: 'Get possible Warehouse storage.' description: '' parameters: - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string - in: header name: Authorization description: '' example: "required Basic + base64 encoded 'user_id:api_token'" schema: type: string 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 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: sed receiverZip: type: required description: 'string Receiver zip number' example: dolores consolidationOrder: type: required description: 'bool Consolidation order ? 0=No; 1=Yes' example: eum skladCreateLabel: type: required description: 'bool Sklad Create Label for order ? 0=No; 1=Yes' example: et tags: - name: 'Authorize Pay' description: '' - name: 'Key Crm' description: '' - name: 'Orders FBM' description: '' - name: Products description: '' - name: 'Proform Data' description: '' - name: Transactions description: '' - name: WarehouseStorage description: ''