openapi: 3.0.3 info: title: PrintOps description: '' version: 1.0.0 servers: - url: 'https://printops.test' paths: /api/base-products: get: summary: 'Get Base Products' operationId: getBaseProducts description: 'Base Products are the core products that PrintOps offers for print on demand.' parameters: [] responses: 200: description: '' content: application/json: schema: type: object example: data: base_products: - id: 1 sku: PP08 name: '8 x 10 Print' product_category: 1 type: poster_sm description: '8x10 Poster Print' properties: ratio: '4:5' width: 8 height: 10 weight: 0.037 paperType: 'Sappi McCoy 80lb/216gsm Coated Cover' thickness: 0.009 ratio_decimal: 0.8 price: '2.25' ships_alone: false - id: 2 sku: PP07 name: '8.5 x 11 Print' product_category: 1 type: poster_sm description: '8.5x11 Poster Print' properties: ratio: '17:22' width: 11 height: 8.5 weight: 0.044 paperType: 'Sappi McCoy 80lb/216gsm Coated Cover' thickness: 0.009 ratio_decimal: 0.773 price: '2.40' ships_alone: false - id: 3 sku: PP09 name: '9 x 12 Print' product_category: 1 type: poster_sm description: '9x12 Poster Print' properties: ratio: '3:4' width: 9 height: 12 weight: 0.05 paperType: 'Sappi McCoy 80lb/216gsm Coated Cover' thickness: 0.009 ratio_decimal: 0.75 price: '2.63' ships_alone: false - id: 4 sku: PP10 name: '11 x 14 Print' product_category: 1 type: poster_sm description: '11x14 Poster Print' properties: ratio: '11:14' width: 11 height: 14 weight: 0.071 paperType: 'Sappi McCoy 80lb/216gsm Coated Cover' thickness: 0.009 ratio_decimal: 0.786 price: '2.78' ships_alone: false - id: 5 sku: PP11 name: '11 x 17 Print' product_category: 1 type: poster_sm description: '11x17 Poster Print' properties: ratio: '11:17' width: 11 height: 17 weight: 0.087 paperType: 'Sappi McCoy 80lb/216gsm Coated Cover' thickness: 0.009 ratio_decimal: 0.647 price: '3.00' ships_alone: false - id: 6 sku: PP12 name: '12 x 16 Print' product_category: 1 type: poster_sm description: '12x16 Poster Print' properties: ratio: '3:4' width: 12 height: 16 weight: 0.089 paperType: 'Sappi McCoy 80lb/216gsm Coated Cover' thickness: 0.009 ratio_decimal: 0.75 price: '3.38' ships_alone: false - id: 7 sku: PP13 name: '12 x 18 Print' product_category: 1 type: poster_sm description: '12x18 Poster Print' properties: ratio: '2:3' width: 12 height: 18 weight: 0.1 paperType: 'Sappi McCoy 80lb/216gsm Coated Cover' thickness: 0.009 ratio_decimal: 0.666 price: '3.75' ships_alone: false - id: 8 sku: PP14 name: '14 x 20 Print' product_category: 1 type: poster_sm description: '14x20 Poster Print' properties: ratio: '7:10' width: 14 height: 20 weight: 0.13 paperType: 'Sappi McCoy 80lb/216gsm Coated Cover' thickness: 0.009 ratio_decimal: 0.7 price: '4.00' ships_alone: false - id: 9 sku: PP16 name: '16 x 20 Print' product_category: 1 type: poster_sm description: '16x20 Poster Print' properties: ratio: '4:5' width: 16 height: 20 weight: 0.148 paperType: 'Sappi McCoy 80lb/216gsm Coated Cover' thickness: 0.009 ratio_decimal: 0.8 price: '4.50' ships_alone: false - id: 10 sku: PP15 name: '16 x 24 Print' product_category: 1 type: poster_sm description: '16x24 Poster Print' properties: ratio: '2:3' width: 16 height: 24 weight: 0.178 paperType: 'Sappi McCoy 80lb/216gsm Coated Cover' thickness: 0.009 ratio_decimal: 0.666 price: '5.00' ships_alone: false - id: 11 sku: PP17 name: '17 x 22 Print' product_category: 1 type: poster_sm description: '17x22 Poster Print' properties: ratio: '17:22' width: 17 height: 22 weight: 0.173 paperType: 'Sappi McCoy 80lb/216gsm Coated Cover' thickness: 0.009 ratio_decimal: 0.773 price: '5.25' ships_alone: false - id: 12 sku: PP18 name: '18 x 24 Print' product_category: 1 type: poster_sm description: '18x24 Poster Print' properties: ratio: '3:4' width: 18 height: 24 weight: 0.2 paperType: 'Sappi McCoy 80lb/216gsm Coated Cover' thickness: 0.009 ratio_decimal: 0.75 price: '6.00' ships_alone: false - id: 13 sku: PP19 name: '18 x 27 Print' product_category: 1 type: poster_sm description: '18 x 27 Poster Print' properties: ratio: '2:3' width: 18 height: 27 weight: 0.225 paperType: 'Sappi McCoy 80lb/216gsm Coated Cover' thickness: 0.009 ratio_decimal: 0.666 price: '6.75' ships_alone: false - id: 14 sku: PP20 name: '20 x 30 Print' product_category: 1 type: poster_lg description: '20x30 Poster Print' properties: ratio: '2:3' width: 20 height: 30 weight: 0.278 paperType: 'Canon Oce 46lb Bond' thickness: 0.008 ratio_decimal: 0.666 price: '11.00' ships_alone: false - id: 15 sku: PP24 name: '24 x 36 Print' product_category: 1 type: poster_lg description: '24x36 Poster Print' properties: ratio: '2:3' width: 24 height: 36 weight: 0.4 paperType: 'Canon Oce 46lb Bond' thickness: 0.008 ratio_decimal: 0.666 price: '15.00' ships_alone: false links: first: 'https://printops.test/api/base-products?page=1' last: 'https://printops.test/api/base-products?page=7' prev: null next: 'https://printops.test/api/base-products?page=2' meta: current_page: 1 from: 1 last_page: 7 links: - url: null label: '« Previous' active: false - url: 'https://printops.test/api/base-products?page=1' label: '1' active: true - url: 'https://printops.test/api/base-products?page=2' label: '2' active: false - url: 'https://printops.test/api/base-products?page=3' label: '3' active: false - url: 'https://printops.test/api/base-products?page=4' label: '4' active: false - url: 'https://printops.test/api/base-products?page=5' label: '5' active: false - url: 'https://printops.test/api/base-products?page=6' label: '6' active: false - url: 'https://printops.test/api/base-products?page=7' label: '7' active: false - url: 'https://printops.test/api/base-products?page=2' label: 'Next »' active: false path: 'https://printops.test/api/base-products' per_page: 15 to: 15 total: 104 status: OK code: 200 messages: [] properties: data: type: object properties: base_products: type: array example: - id: 1 sku: PP08 name: '8 x 10 Print' product_category: 1 type: poster_sm description: '8x10 Poster Print' properties: ratio: '4:5' width: 8 height: 10 weight: 0.037 paperType: 'Sappi McCoy 80lb/216gsm Coated Cover' thickness: 0.009 ratio_decimal: 0.8 price: '2.25' ships_alone: false - id: 2 sku: PP07 name: '8.5 x 11 Print' product_category: 1 type: poster_sm description: '8.5x11 Poster Print' properties: ratio: '17:22' width: 11 height: 8.5 weight: 0.044 paperType: 'Sappi McCoy 80lb/216gsm Coated Cover' thickness: 0.009 ratio_decimal: 0.773 price: '2.40' ships_alone: false - id: 3 sku: PP09 name: '9 x 12 Print' product_category: 1 type: poster_sm description: '9x12 Poster Print' properties: ratio: '3:4' width: 9 height: 12 weight: 0.05 paperType: 'Sappi McCoy 80lb/216gsm Coated Cover' thickness: 0.009 ratio_decimal: 0.75 price: '2.63' ships_alone: false - id: 4 sku: PP10 name: '11 x 14 Print' product_category: 1 type: poster_sm description: '11x14 Poster Print' properties: ratio: '11:14' width: 11 height: 14 weight: 0.071 paperType: 'Sappi McCoy 80lb/216gsm Coated Cover' thickness: 0.009 ratio_decimal: 0.786 price: '2.78' ships_alone: false - id: 5 sku: PP11 name: '11 x 17 Print' product_category: 1 type: poster_sm description: '11x17 Poster Print' properties: ratio: '11:17' width: 11 height: 17 weight: 0.087 paperType: 'Sappi McCoy 80lb/216gsm Coated Cover' thickness: 0.009 ratio_decimal: 0.647 price: '3.00' ships_alone: false - id: 6 sku: PP12 name: '12 x 16 Print' product_category: 1 type: poster_sm description: '12x16 Poster Print' properties: ratio: '3:4' width: 12 height: 16 weight: 0.089 paperType: 'Sappi McCoy 80lb/216gsm Coated Cover' thickness: 0.009 ratio_decimal: 0.75 price: '3.38' ships_alone: false - id: 7 sku: PP13 name: '12 x 18 Print' product_category: 1 type: poster_sm description: '12x18 Poster Print' properties: ratio: '2:3' width: 12 height: 18 weight: 0.1 paperType: 'Sappi McCoy 80lb/216gsm Coated Cover' thickness: 0.009 ratio_decimal: 0.666 price: '3.75' ships_alone: false - id: 8 sku: PP14 name: '14 x 20 Print' product_category: 1 type: poster_sm description: '14x20 Poster Print' properties: ratio: '7:10' width: 14 height: 20 weight: 0.13 paperType: 'Sappi McCoy 80lb/216gsm Coated Cover' thickness: 0.009 ratio_decimal: 0.7 price: '4.00' ships_alone: false - id: 9 sku: PP16 name: '16 x 20 Print' product_category: 1 type: poster_sm description: '16x20 Poster Print' properties: ratio: '4:5' width: 16 height: 20 weight: 0.148 paperType: 'Sappi McCoy 80lb/216gsm Coated Cover' thickness: 0.009 ratio_decimal: 0.8 price: '4.50' ships_alone: false - id: 10 sku: PP15 name: '16 x 24 Print' product_category: 1 type: poster_sm description: '16x24 Poster Print' properties: ratio: '2:3' width: 16 height: 24 weight: 0.178 paperType: 'Sappi McCoy 80lb/216gsm Coated Cover' thickness: 0.009 ratio_decimal: 0.666 price: '5.00' ships_alone: false - id: 11 sku: PP17 name: '17 x 22 Print' product_category: 1 type: poster_sm description: '17x22 Poster Print' properties: ratio: '17:22' width: 17 height: 22 weight: 0.173 paperType: 'Sappi McCoy 80lb/216gsm Coated Cover' thickness: 0.009 ratio_decimal: 0.773 price: '5.25' ships_alone: false - id: 12 sku: PP18 name: '18 x 24 Print' product_category: 1 type: poster_sm description: '18x24 Poster Print' properties: ratio: '3:4' width: 18 height: 24 weight: 0.2 paperType: 'Sappi McCoy 80lb/216gsm Coated Cover' thickness: 0.009 ratio_decimal: 0.75 price: '6.00' ships_alone: false - id: 13 sku: PP19 name: '18 x 27 Print' product_category: 1 type: poster_sm description: '18 x 27 Poster Print' properties: ratio: '2:3' width: 18 height: 27 weight: 0.225 paperType: 'Sappi McCoy 80lb/216gsm Coated Cover' thickness: 0.009 ratio_decimal: 0.666 price: '6.75' ships_alone: false - id: 14 sku: PP20 name: '20 x 30 Print' product_category: 1 type: poster_lg description: '20x30 Poster Print' properties: ratio: '2:3' width: 20 height: 30 weight: 0.278 paperType: 'Canon Oce 46lb Bond' thickness: 0.008 ratio_decimal: 0.666 price: '11.00' ships_alone: false - id: 15 sku: PP24 name: '24 x 36 Print' product_category: 1 type: poster_lg description: '24x36 Poster Print' properties: ratio: '2:3' width: 24 height: 36 weight: 0.4 paperType: 'Canon Oce 46lb Bond' thickness: 0.008 ratio_decimal: 0.666 price: '15.00' ships_alone: false items: type: object properties: id: type: integer example: 1 sku: type: string example: PP08 name: type: string example: '8 x 10 Print' product_category: type: integer example: 1 type: type: string example: poster_sm description: type: string example: '8x10 Poster Print' properties: type: object properties: ratio: type: string example: '4:5' width: type: integer example: 8 height: type: integer example: 10 weight: type: number example: 0.037 paperType: type: string example: 'Sappi McCoy 80lb/216gsm Coated Cover' thickness: type: number example: 0.009 ratio_decimal: type: number example: 0.8 price: type: string example: '2.25' ships_alone: type: boolean example: false links: type: object properties: first: type: string example: 'https://printops.test/api/base-products?page=1' last: type: string example: 'https://printops.test/api/base-products?page=7' prev: type: string example: null next: type: string example: 'https://printops.test/api/base-products?page=2' meta: type: object properties: current_page: type: integer example: 1 from: type: integer example: 1 last_page: type: integer example: 7 links: type: array example: - url: null label: '« Previous' active: false - url: 'https://printops.test/api/base-products?page=1' label: '1' active: true - url: 'https://printops.test/api/base-products?page=2' label: '2' active: false - url: 'https://printops.test/api/base-products?page=3' label: '3' active: false - url: 'https://printops.test/api/base-products?page=4' label: '4' active: false - url: 'https://printops.test/api/base-products?page=5' label: '5' active: false - url: 'https://printops.test/api/base-products?page=6' label: '6' active: false - url: 'https://printops.test/api/base-products?page=7' label: '7' active: false - url: 'https://printops.test/api/base-products?page=2' label: 'Next »' active: false items: type: object properties: url: type: string example: null label: type: string example: '« Previous' active: type: boolean example: false path: type: string example: 'https://printops.test/api/base-products' per_page: type: integer example: 15 to: type: integer example: 15 total: type: integer example: 104 status: type: string example: OK code: type: integer example: 200 messages: type: array example: [] tags: - Endpoints parameters: - in: path name: page description: 'Optional parameter. The page number for pagination.' required: true schema: type: integer examples: omitted: summary: 'When the value is omitted' value: '' present: summary: 'When the value is present' value: 1 - in: path name: product_category_id description: 'Optional parameter. Filter products by product category.' required: true schema: type: integer examples: omitted: summary: 'When the value is omitted' value: '' present: summary: 'When the value is present' value: 1 - in: path name: limit description: 'Optional parameter. The number of records to return per page. Exmaple: 2' required: true schema: type: integer examples: omitted: summary: 'When the value is omitted' value: '' present: summary: 'When the value is present' value: 9 '/api/base-products/{baseProduct}': get: summary: 'Get a Base Product by Id' operationId: getABaseProductById description: 'Base Products are the core products that PrintOps offers for print on demand.' parameters: [] responses: 200: description: '' content: application/json: schema: type: object example: data: base_product: id: 1 sku: PP08 name: '8 x 10 Print' product_category: 1 type: poster_sm description: '8x10 Poster Print' properties: ratio: '4:5' width: 8 height: 10 weight: 0.037 paperType: 'Sappi McCoy 80lb/216gsm Coated Cover' thickness: 0.009 ratio_decimal: 0.8 price: '2.25' ships_alone: false status: OK code: 200 messages: [] properties: data: type: object properties: base_product: type: object properties: id: type: integer example: 1 sku: type: string example: PP08 name: type: string example: '8 x 10 Print' product_category: type: integer example: 1 type: type: string example: poster_sm description: type: string example: '8x10 Poster Print' properties: type: object properties: ratio: type: string example: '4:5' width: type: integer example: 8 height: type: integer example: 10 weight: type: number example: 0.037 paperType: type: string example: 'Sappi McCoy 80lb/216gsm Coated Cover' thickness: type: number example: 0.009 ratio_decimal: type: number example: 0.8 price: type: string example: '2.25' ships_alone: type: boolean example: false status: type: string example: OK code: type: integer example: 200 messages: type: array example: [] tags: - Endpoints parameters: - in: path name: baseProduct description: 'The id of the base product.' example: '1' required: true schema: type: string /api/authentication-test: get: summary: 'Authentication Test' operationId: authenticationTest description: 'A simple endpoint to confirm authentication was successful.' parameters: [] responses: 200: description: '' content: application/json: schema: type: object example: data: message: - 'Success - you are authenticated.' status: OK code: 200 messages: [] properties: data: type: object properties: message: type: array example: - 'Success - you are authenticated.' items: type: string status: type: string example: OK code: type: integer example: 200 messages: type: array example: [] tags: - Endpoints /api/shipping-methods: get: summary: 'Get Shipping Methods' operationId: getShippingMethods description: 'Returns a list of all available shipping methods.' parameters: [] responses: 200: description: '' content: application/json: schema: type: object example: data: shipping_methods: - shipping_carrier: UPS name: 'UPS Standard℠' identifier: ups_standard - shipping_carrier: UPS name: 'UPS® Ground' identifier: ups_ground - shipping_carrier: UPS name: 'UPS Saver®' identifier: ups_saver - shipping_carrier: UPS name: 'UPS Three-Day Select®' identifier: ups_3_day_select - shipping_carrier: UPS name: 'UPS Second Day Air®' identifier: ups_second_day_air - shipping_carrier: UPS name: 'UPS Second Day Air A.M.®' identifier: ups_second_day_air_am - shipping_carrier: UPS name: 'UPS Next Day Air®' identifier: ups_next_day_air - shipping_carrier: UPS name: 'UPS Next Day Air Saver®' identifier: ups_next_day_air_saver - shipping_carrier: UPS name: 'UPS Next Day Air Early A.M.®' identifier: ups_next_day_air_early_am - shipping_carrier: UPS name: 'UPS Mail Innovations (domestic)' identifier: ups_mail_innovations_domestic - shipping_carrier: UPS name: 'UPS Express®' identifier: ups_express - shipping_carrier: UPS name: 'UPS Express Plus®' identifier: ups_express_plus - shipping_carrier: UPS name: 'UPS Expedited®' identifier: ups_expedited - shipping_carrier: USPS name: 'USPS Priority Mail' identifier: usps_priority - shipping_carrier: USPS name: 'USPS Priority Mail Express' identifier: usps_priority_express - shipping_carrier: USPS name: 'USPS First Class' identifier: usps_first - shipping_carrier: USPS name: 'USPS Parcel Select' identifier: usps_parcel_select - shipping_carrier: USPS name: 'USPS Media Mail' identifier: usps_media_mail - shipping_carrier: USPS name: 'USPS International Priority' identifier: usps_priority_mail_international - shipping_carrier: USPS name: 'USPS International Express' identifier: usps_priority_mail_express_international - shipping_carrier: USPS name: 'USPS International First' identifier: usps_first_class_package_international_service - shipping_carrier: FedEx name: Ground identifier: fedex_ground - shipping_carrier: FedEx name: 'Home Delivery' identifier: fedex_home_delivery - shipping_carrier: FedEx name: Smartpost identifier: fedex_smart_post - shipping_carrier: FedEx name: '2 Day' identifier: fedex_2_day - shipping_carrier: FedEx name: '2 Day A.M.' identifier: fedex_2_day_am - shipping_carrier: FedEx name: 'Express Saver' identifier: fedex_express_saver - shipping_carrier: FedEx name: 'Standard Overnight' identifier: fedex_standard_overnight - shipping_carrier: FedEx name: 'Priority Overnight' identifier: fedex_priority_overnight - shipping_carrier: FedEx name: 'First Overnight' identifier: fedex_first_overnight - shipping_carrier: FedEx name: 'International Economy' identifier: fedex_international_economy - shipping_carrier: FedEx name: 'International Priority' identifier: fedex_international_priority - shipping_carrier: FedEx name: 'International First' identifier: fedex_international_first - shipping_carrier: FedEx name: 'Europe First International Priority' identifier: fedex_europe_first_international_priority - shipping_carrier: Flat name: 'Flat Rate' identifier: flat_rate - shipping_carrier: USPS name: 'USPS Ground Advantage' identifier: usps_ground_advantage status: OK code: 200 messages: [] properties: data: type: object properties: shipping_methods: type: array example: - shipping_carrier: UPS name: 'UPS Standard℠' identifier: ups_standard - shipping_carrier: UPS name: 'UPS® Ground' identifier: ups_ground - shipping_carrier: UPS name: 'UPS Saver®' identifier: ups_saver - shipping_carrier: UPS name: 'UPS Three-Day Select®' identifier: ups_3_day_select - shipping_carrier: UPS name: 'UPS Second Day Air®' identifier: ups_second_day_air - shipping_carrier: UPS name: 'UPS Second Day Air A.M.®' identifier: ups_second_day_air_am - shipping_carrier: UPS name: 'UPS Next Day Air®' identifier: ups_next_day_air - shipping_carrier: UPS name: 'UPS Next Day Air Saver®' identifier: ups_next_day_air_saver - shipping_carrier: UPS name: 'UPS Next Day Air Early A.M.®' identifier: ups_next_day_air_early_am - shipping_carrier: UPS name: 'UPS Mail Innovations (domestic)' identifier: ups_mail_innovations_domestic - shipping_carrier: UPS name: 'UPS Express®' identifier: ups_express - shipping_carrier: UPS name: 'UPS Express Plus®' identifier: ups_express_plus - shipping_carrier: UPS name: 'UPS Expedited®' identifier: ups_expedited - shipping_carrier: USPS name: 'USPS Priority Mail' identifier: usps_priority - shipping_carrier: USPS name: 'USPS Priority Mail Express' identifier: usps_priority_express - shipping_carrier: USPS name: 'USPS First Class' identifier: usps_first - shipping_carrier: USPS name: 'USPS Parcel Select' identifier: usps_parcel_select - shipping_carrier: USPS name: 'USPS Media Mail' identifier: usps_media_mail - shipping_carrier: USPS name: 'USPS International Priority' identifier: usps_priority_mail_international - shipping_carrier: USPS name: 'USPS International Express' identifier: usps_priority_mail_express_international - shipping_carrier: USPS name: 'USPS International First' identifier: usps_first_class_package_international_service - shipping_carrier: FedEx name: Ground identifier: fedex_ground - shipping_carrier: FedEx name: 'Home Delivery' identifier: fedex_home_delivery - shipping_carrier: FedEx name: Smartpost identifier: fedex_smart_post - shipping_carrier: FedEx name: '2 Day' identifier: fedex_2_day - shipping_carrier: FedEx name: '2 Day A.M.' identifier: fedex_2_day_am - shipping_carrier: FedEx name: 'Express Saver' identifier: fedex_express_saver - shipping_carrier: FedEx name: 'Standard Overnight' identifier: fedex_standard_overnight - shipping_carrier: FedEx name: 'Priority Overnight' identifier: fedex_priority_overnight - shipping_carrier: FedEx name: 'First Overnight' identifier: fedex_first_overnight - shipping_carrier: FedEx name: 'International Economy' identifier: fedex_international_economy - shipping_carrier: FedEx name: 'International Priority' identifier: fedex_international_priority - shipping_carrier: FedEx name: 'International First' identifier: fedex_international_first - shipping_carrier: FedEx name: 'Europe First International Priority' identifier: fedex_europe_first_international_priority - shipping_carrier: Flat name: 'Flat Rate' identifier: flat_rate - shipping_carrier: USPS name: 'USPS Ground Advantage' identifier: usps_ground_advantage items: type: object properties: shipping_carrier: type: string example: UPS name: type: string example: 'UPS Standard℠' identifier: type: string example: ups_standard status: type: string example: OK code: type: integer example: 200 messages: type: array example: [] tags: - Endpoints /api/stores: get: summary: 'Get Stores' operationId: getStores description: 'The store resource is an organizational unit that holds user products, orders and shipments.' parameters: - in: query name: limit description: 'The number of records to return per page.' example: 2 required: false schema: type: integer description: 'The number of records to return per page.' example: 2 - in: query name: page description: 'The page number for pagination.' example: 1 required: false schema: type: integer description: 'The page number for pagination.' example: 1 responses: 200: description: '' content: application/json: schema: type: object example: data: stores: - id: 786323 name: 'The Cat Store' type: generic is_live: true dropbox_name: null - id: 786326 name: 'My Great Store' type: generic is_live: true dropbox_name: null links: first: 'https://printops.test/api/stores?page=1' last: 'https://printops.test/api/stores?page=2' prev: null next: 'https://printops.test/api/stores?page=2' meta: current_page: 1 from: 1 last_page: 2 links: - url: null label: '« Previous' active: false - url: 'https://printops.test/api/stores?page=1' label: '1' active: true - url: 'https://printops.test/api/stores?page=2' label: '2' active: false - url: 'https://printops.test/api/stores?page=2' label: 'Next »' active: false path: 'https://printops.test/api/stores' per_page: 2 to: 2 total: 3 status: OK code: 200 messages: [] properties: data: type: object properties: stores: type: array example: - id: 786323 name: 'The Cat Store' type: generic is_live: true dropbox_name: null - id: 786326 name: 'My Great Store' type: generic is_live: true dropbox_name: null items: type: object properties: id: type: integer example: 786323 name: type: string example: 'The Cat Store' type: type: string example: generic is_live: type: boolean example: true dropbox_name: type: string example: null links: type: object properties: first: type: string example: 'https://printops.test/api/stores?page=1' last: type: string example: 'https://printops.test/api/stores?page=2' prev: type: string example: null next: type: string example: 'https://printops.test/api/stores?page=2' meta: type: object properties: current_page: type: integer example: 1 from: type: integer example: 1 last_page: type: integer example: 2 links: type: array example: - url: null label: '« Previous' active: false - url: 'https://printops.test/api/stores?page=1' label: '1' active: true - url: 'https://printops.test/api/stores?page=2' label: '2' active: false - url: 'https://printops.test/api/stores?page=2' label: 'Next »' active: false items: type: object properties: url: type: string example: null label: type: string example: '« Previous' active: type: boolean example: false path: type: string example: 'https://printops.test/api/stores' per_page: type: integer example: 2 to: type: integer example: 2 total: type: integer example: 3 status: type: string example: OK code: type: integer example: 200 messages: type: array example: [] tags: - Endpoints post: summary: 'Create a store' operationId: createAStore description: '' parameters: [] responses: 201: description: '' content: application/json: schema: type: object example: data: store: id: 786323 name: 'My Great Store' type: generic is_live: true dropbox_name: null status: created code: 201 messages: [] properties: data: type: object properties: store: type: object properties: id: type: integer example: 786323 name: type: string example: 'My Great Store' type: type: string example: generic is_live: type: boolean example: true dropbox_name: type: string example: null status: type: string example: created code: type: integer example: 201 messages: type: array example: [] tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: 'Name of the store.' example: 'My Great Store' type: type: string description: 'Type of store.' example: generic shipping_address: type: object description: '' example: state: TX properties: state: type: string description: 'Shipping address state.' example: TX required: - name - type '/api/stores/{store}': get: summary: 'Get a Store by Id' operationId: getAStoreById description: '' parameters: [] responses: 200: description: '' content: application/json: schema: type: object example: data: store: id: 786323 name: 'The Cat Store' type: generic is_live: true dropbox_name: null status: OK code: 200 messages: [] properties: data: type: object properties: store: type: object properties: id: type: integer example: 786323 name: type: string example: 'The Cat Store' type: type: string example: generic is_live: type: boolean example: true dropbox_name: type: string example: null status: type: string example: OK code: type: integer example: 200 messages: type: array example: [] tags: - Endpoints parameters: - in: path name: store description: 'Optional parameter. The id of the store.' required: true schema: type: integer examples: omitted: summary: 'When the value is omitted' value: '' present: summary: 'When the value is present' value: 786323 /api/images: get: summary: 'Get Images' operationId: getImages description: 'Get images that have been created through the UI.' parameters: - in: query name: limit description: 'The number of records to return per page.' example: 2 required: false schema: type: integer description: 'The number of records to return per page.' example: 2 - in: query name: page description: 'The page number for pagination.' example: 1 required: false schema: type: integer description: 'The page number for pagination.' example: 1 responses: 200: description: '' content: application/json: schema: type: object example: data: images: - id: 19 thumbnail_path: 1707423668-65c537b417578-thumbnail.jpg original_name: 100.jpg pixel_width: 675 pixel_height: 926 native_width: '9.38' native_height: '12.86' aspect_ratio: '0.7293934681182' resolution: '72.00' is_active: 0 extension: jpg image_token: r73vmX9YFbBpTsyZpJENKrrDThdDdEEd created_at: '2024-02-08T20:21:08.000000Z' updated_at: '2024-02-08T20:21:08.000000Z' - id: 20 thumbnail_path: 1707425211-65c53dbb76d9e-thumbnail.jpg original_name: cat.jpg pixel_width: 1024 pixel_height: 1024 native_width: '14.22' native_height: '14.22' aspect_ratio: '1' resolution: '72.00' is_active: 1 extension: jpg image_token: 4jhdcUY64NOqC11fSsiYzq63dMkC22uU created_at: '2024-02-08T20:46:51.000000Z' updated_at: '2024-02-08T21:11:46.000000Z' links: first: 'https://printops.test/api/images?page=1' last: 'https://printops.test/api/images?page=13' prev: null next: 'https://printops.test/api/images?page=2' meta: current_page: 1 from: 1 last_page: 13 links: - url: null label: '« Previous' active: false - url: 'https://printops.test/api/images?page=1' label: '1' active: true - url: 'https://printops.test/api/images?page=2' label: '2' active: false - url: 'https://printops.test/api/images?page=3' label: '3' active: false - url: 'https://printops.test/api/images?page=4' label: '4' active: false - url: 'https://printops.test/api/images?page=5' label: '5' active: false - url: 'https://printops.test/api/images?page=6' label: '6' active: false - url: 'https://printops.test/api/images?page=7' label: '7' active: false - url: 'https://printops.test/api/images?page=8' label: '8' active: false - url: 'https://printops.test/api/images?page=9' label: '9' active: false - url: 'https://printops.test/api/images?page=10' label: '10' active: false - url: 'https://printops.test/api/images?page=11' label: '11' active: false - url: 'https://printops.test/api/images?page=12' label: '12' active: false - url: 'https://printops.test/api/images?page=13' label: '13' active: false - url: 'https://printops.test/api/images?page=2' label: 'Next »' active: false path: 'https://printops.test/api/images' per_page: 2 to: 2 total: 25 status: OK code: 200 messages: [] properties: data: type: object properties: images: type: array example: - id: 19 thumbnail_path: 1707423668-65c537b417578-thumbnail.jpg original_name: 100.jpg pixel_width: 675 pixel_height: 926 native_width: '9.38' native_height: '12.86' aspect_ratio: '0.7293934681182' resolution: '72.00' is_active: 0 extension: jpg image_token: r73vmX9YFbBpTsyZpJENKrrDThdDdEEd created_at: '2024-02-08T20:21:08.000000Z' updated_at: '2024-02-08T20:21:08.000000Z' - id: 20 thumbnail_path: 1707425211-65c53dbb76d9e-thumbnail.jpg original_name: cat.jpg pixel_width: 1024 pixel_height: 1024 native_width: '14.22' native_height: '14.22' aspect_ratio: '1' resolution: '72.00' is_active: 1 extension: jpg image_token: 4jhdcUY64NOqC11fSsiYzq63dMkC22uU created_at: '2024-02-08T20:46:51.000000Z' updated_at: '2024-02-08T21:11:46.000000Z' items: type: object properties: id: type: integer example: 19 thumbnail_path: type: string example: 1707423668-65c537b417578-thumbnail.jpg original_name: type: string example: 100.jpg pixel_width: type: integer example: 675 pixel_height: type: integer example: 926 native_width: type: string example: '9.38' native_height: type: string example: '12.86' aspect_ratio: type: string example: '0.7293934681182' resolution: type: string example: '72.00' is_active: type: integer example: 0 extension: type: string example: jpg image_token: type: string example: r73vmX9YFbBpTsyZpJENKrrDThdDdEEd created_at: type: string example: '2024-02-08T20:21:08.000000Z' updated_at: type: string example: '2024-02-08T20:21:08.000000Z' links: type: object properties: first: type: string example: 'https://printops.test/api/images?page=1' last: type: string example: 'https://printops.test/api/images?page=13' prev: type: string example: null next: type: string example: 'https://printops.test/api/images?page=2' meta: type: object properties: current_page: type: integer example: 1 from: type: integer example: 1 last_page: type: integer example: 13 links: type: array example: - url: null label: '« Previous' active: false - url: 'https://printops.test/api/images?page=1' label: '1' active: true - url: 'https://printops.test/api/images?page=2' label: '2' active: false - url: 'https://printops.test/api/images?page=3' label: '3' active: false - url: 'https://printops.test/api/images?page=4' label: '4' active: false - url: 'https://printops.test/api/images?page=5' label: '5' active: false - url: 'https://printops.test/api/images?page=6' label: '6' active: false - url: 'https://printops.test/api/images?page=7' label: '7' active: false - url: 'https://printops.test/api/images?page=8' label: '8' active: false - url: 'https://printops.test/api/images?page=9' label: '9' active: false - url: 'https://printops.test/api/images?page=10' label: '10' active: false - url: 'https://printops.test/api/images?page=11' label: '11' active: false - url: 'https://printops.test/api/images?page=12' label: '12' active: false - url: 'https://printops.test/api/images?page=13' label: '13' active: false - url: 'https://printops.test/api/images?page=2' label: 'Next »' active: false items: type: object properties: url: type: string example: null label: type: string example: '« Previous' active: type: boolean example: false path: type: string example: 'https://printops.test/api/images' per_page: type: integer example: 2 to: type: integer example: 2 total: type: integer example: 25 status: type: string example: OK code: type: integer example: 200 messages: type: array example: [] tags: - Endpoints '/api/images/{image}': get: summary: 'Get an Image By Id' operationId: getAnImageById description: 'Get an image that has been created through the UI.' parameters: [] responses: 200: description: '' content: application/json: schema: type: object example: data: image: id: 20 thumbnail_path: 1707425211-65c53dbb76d9e-thumbnail.jpg original_name: cat.jpg pixel_width: 1024 pixel_height: 1024 native_width: '14.22' native_height: '14.22' aspect_ratio: '1' resolution: '72.00' is_active: 1 extension: jpg image_token: 4jhdcUY64NOqC11fSsiYzq63dMkC22uU created_at: '2024-02-08T20:46:51.000000Z' updated_at: '2024-02-08T21:11:46.000000Z' status: OK code: 200 messages: [] properties: data: type: object properties: image: type: object properties: id: type: integer example: 20 thumbnail_path: type: string example: 1707425211-65c53dbb76d9e-thumbnail.jpg original_name: type: string example: cat.jpg pixel_width: type: integer example: 1024 pixel_height: type: integer example: 1024 native_width: type: string example: '14.22' native_height: type: string example: '14.22' aspect_ratio: type: string example: '1' resolution: type: string example: '72.00' is_active: type: integer example: 1 extension: type: string example: jpg image_token: type: string example: 4jhdcUY64NOqC11fSsiYzq63dMkC22uU created_at: type: string example: '2024-02-08T20:46:51.000000Z' updated_at: type: string example: '2024-02-08T21:11:46.000000Z' status: type: string example: OK code: type: integer example: 200 messages: type: array example: [] tags: - Endpoints parameters: - in: path name: image description: 'Optional parameter. The id of the image.' required: true schema: type: integer examples: omitted: summary: 'When the value is omitted' value: '' present: summary: 'When the value is present' value: 20 '/api/stores/{store}/user-products': get: summary: 'Get User Products' operationId: getUserProducts description: 'The user product resource is the customized product that PrintOps fulfills. It includes details such as the underlying base product and associated art file. User products belong to a single store.' parameters: - in: query name: page description: 'The page number for pagination.' example: 1 required: false schema: type: integer description: 'The page number for pagination.' example: 1 - in: query name: product_category_id description: 'Filter products by product category.' example: 1 required: false schema: type: integer description: 'Filter products by product category.' example: 1 - in: query name: limit description: 'The number of records to return per page.' example: 2 required: false schema: type: integer description: 'The number of records to return per page.' example: 2 responses: 200: description: '' content: application/json: schema: type: object example: data: user_products: - id: 47352 store_id: 786323 base_product_id: 10 type: null external_product_id: null user_sku: vision-quest name: vision-quest scale_option: fit description: vision-quest base_product: id: 10 sku: PP15 name: '16 x 24 Print' product_category: 1 type: poster_sm description: '16x24 Poster Print' properties: ratio: '2:3' width: 16 height: 24 weight: 0.178 paperType: 'Sappi McCoy 80lb/216gsm Coated Cover' thickness: 0.009 ratio_decimal: 0.666 price: '5.00' ships_alone: false thumbnail: 'https://printops.s3.amazonaws.com/1246/thumbnails/78XwLCBvHAzQT5mqt0HVYwky5uWnCKvz1Jyx0hhy.jpg' links: first: 'https://printops.test/api/stores/786323/user-products?page=1' last: 'https://printops.test/api/stores/786323/user-products?page=1' prev: null next: null meta: current_page: 1 from: 1 last_page: 1 links: - url: null label: '« Previous' active: false - url: 'https://printops.test/api/stores/786323/user-products?page=1' label: '1' active: true - url: null label: 'Next »' active: false path: 'https://printops.test/api/stores/786323/user-products' per_page: 2 to: 1 total: 1 status: OK code: 200 messages: [] properties: data: type: object properties: user_products: type: array example: - id: 47352 store_id: 786323 base_product_id: 10 type: null external_product_id: null user_sku: vision-quest name: vision-quest scale_option: fit description: vision-quest base_product: id: 10 sku: PP15 name: '16 x 24 Print' product_category: 1 type: poster_sm description: '16x24 Poster Print' properties: ratio: '2:3' width: 16 height: 24 weight: 0.178 paperType: 'Sappi McCoy 80lb/216gsm Coated Cover' thickness: 0.009 ratio_decimal: 0.666 price: '5.00' ships_alone: false thumbnail: 'https://printops.s3.amazonaws.com/1246/thumbnails/78XwLCBvHAzQT5mqt0HVYwky5uWnCKvz1Jyx0hhy.jpg' items: type: object properties: id: type: integer example: 47352 store_id: type: integer example: 786323 base_product_id: type: integer example: 10 type: type: string example: null external_product_id: type: string example: null user_sku: type: string example: vision-quest name: type: string example: vision-quest scale_option: type: string example: fit description: type: string example: vision-quest base_product: type: object properties: id: type: integer example: 10 sku: type: string example: PP15 name: type: string example: '16 x 24 Print' product_category: type: integer example: 1 type: type: string example: poster_sm description: type: string example: '16x24 Poster Print' properties: type: object properties: ratio: type: string example: '2:3' width: type: integer example: 16 height: type: integer example: 24 weight: type: number example: 0.178 paperType: type: string example: 'Sappi McCoy 80lb/216gsm Coated Cover' thickness: type: number example: 0.009 ratio_decimal: type: number example: 0.666 price: type: string example: '5.00' ships_alone: type: boolean example: false thumbnail: type: string example: 'https://printops.s3.amazonaws.com/1246/thumbnails/78XwLCBvHAzQT5mqt0HVYwky5uWnCKvz1Jyx0hhy.jpg' links: type: object properties: first: type: string example: 'https://printops.test/api/stores/786323/user-products?page=1' last: type: string example: 'https://printops.test/api/stores/786323/user-products?page=1' prev: type: string example: null next: type: string example: null meta: type: object properties: current_page: type: integer example: 1 from: type: integer example: 1 last_page: type: integer example: 1 links: type: array example: - url: null label: '« Previous' active: false - url: 'https://printops.test/api/stores/786323/user-products?page=1' label: '1' active: true - url: null label: 'Next »' active: false items: type: object properties: url: type: string example: null label: type: string example: '« Previous' active: type: boolean example: false path: type: string example: 'https://printops.test/api/stores/786323/user-products' per_page: type: integer example: 2 to: type: integer example: 1 total: type: integer example: 1 status: type: string example: OK code: type: integer example: 200 messages: type: array example: [] tags: - Endpoints parameters: - in: path name: store description: 'The id of the store.' example: '786323' required: true schema: type: string '/api/stores/{store}/user-products/{userProduct}': get: summary: 'Get a User Product by Id' operationId: getAUserProductById description: 'Get a specific User Product that was created in the UI.' parameters: [] responses: 200: description: '' content: application/json: schema: type: object example: data: user_product: id: 47244 store_id: 786323 base_product_id: 21 type: null external_product_id: null user_sku: cat_poster_18x18 name: 'Cat Poster 18x18' scale_option: fit description: 'Cute cat poster sized to 18 x 18' base_product: id: 21 sku: SP18 name: '18 x 18 Square Print' product_category: 2 type: poster_sm description: '18x18 Square Poster Print' properties: ratio: '1:1' width: 18 height: 18 weight: 0.15 paperType: 'Sappi McCoy 80lb/216gsm Coated Cover' thickness: 0.009 ratio_decimal: 1 price: '4.50' ships_alone: false thumbnail: 'https://printops.s3.amazonaws.com/1246/thumbnails/1ZCBPAoVSAc9oLdyuNiwz4rzls3pFEALKGOxVGlD.jpg' status: OK code: 200 messages: [] properties: data: type: object properties: user_product: type: object properties: id: type: integer example: 47244 store_id: type: integer example: 786323 base_product_id: type: integer example: 21 type: type: string example: null external_product_id: type: string example: null user_sku: type: string example: cat_poster_18x18 name: type: string example: 'Cat Poster 18x18' scale_option: type: string example: fit description: type: string example: 'Cute cat poster sized to 18 x 18' base_product: type: object properties: id: type: integer example: 21 sku: type: string example: SP18 name: type: string example: '18 x 18 Square Print' product_category: type: integer example: 2 type: type: string example: poster_sm description: type: string example: '18x18 Square Poster Print' properties: type: object properties: ratio: type: string example: '1:1' width: type: integer example: 18 height: type: integer example: 18 weight: type: number example: 0.15 paperType: type: string example: 'Sappi McCoy 80lb/216gsm Coated Cover' thickness: type: number example: 0.009 ratio_decimal: type: integer example: 1 price: type: string example: '4.50' ships_alone: type: boolean example: false thumbnail: type: string example: 'https://printops.s3.amazonaws.com/1246/thumbnails/1ZCBPAoVSAc9oLdyuNiwz4rzls3pFEALKGOxVGlD.jpg' status: type: string example: OK code: type: integer example: 200 messages: type: array example: [] tags: - Endpoints parameters: - in: path name: store description: 'Optional parameter. The id of the store.' required: true schema: type: integer examples: omitted: summary: 'When the value is omitted' value: '' present: summary: 'When the value is present' value: 786323 - in: path name: userProduct description: 'Optional parameter. The id of the user product.' required: true schema: type: integer examples: omitted: summary: 'When the value is omitted' value: '' present: summary: 'When the value is present' value: 47244 '/api/stores/{store_id}/orders': post: summary: 'Create an Order' operationId: createAnOrder description: "An order is the resource that contains information about what items will be sent to the end customer, how we will send it and where it's going.\n\nWhen submitting an order, you have the option to reference an already created (by you) User Product, or instead, reference a Base Product and send a publicly accessible url of a print file.\n\nThe external_order_id field should be used for an outside order id.\n\nThe requested_shipping field requires a string that matches the code field of an entry in the Shipping Methods resource.\n\nEach item in the Line Items array should have a sku entry that references either an already created User Product sku, or a Base Product sku. When referencing a Base Product sku, you will need to provide a publicly accessible url for a file to download, as well as the filename.\n\nYou can override the Scaling Option of the Base Product by including the scale_option field in the line_item node. The value must be one of the following: noscale, fill, fit or stretch. Read more about scaling options here\n\n" parameters: [] responses: 201: description: '' content: application/json: schema: type: object example: data: orders: - id: 320117 store_id: 786321 type: standard state: received is_live: null requested_shipping: usps_ground_advantage estimated_ship_date: '2024-02-01' external_order_id: 12003210-ABD30 packing_slip_url: null shipping_label_url: null canceled_at: null closed_at: null cancel_reason: null remote_ip: null total_item_count: null gift_message: null line_items: - id: 16 quantity: 1 unit_price: 450 total_price: 450 scale_option: fit user_product: id: 47242 store_id: 786321 base_product_id: 9 type: null external_product_id: null user_sku: tps_report_1 name: 'TPS Report 1' scale_option: fill description: "A TPS report in it's final format." base_product: id: 9 sku: PP16 name: '16 x 20 Print' product_category: 1 type: poster_sm description: '16x20 Poster Print' properties: ratio: '4:5' width: 16 height: 20 weight: 0.148 paperType: 'Sappi McCoy 80lb/216gsm Coated Cover' thickness: 0.009 ratio_decimal: 0.8 thumbnail: 'https://printops.s3.amazonaws.com/1245/thumbnails/iJL4OAm5btnTf66WLtCZb3eSNNQA5JeUWJwBkT1d.jpg' shipping_address: order_id: null company: Initech first_name: Bill last_name: Lumbergh address_1: '4120 Freidrich Lane' address_2: 'Ste 100' city: Austin state: TX postal_code: '78744' country: US phone: 512-251-5221 fulfillments: - id: 621515 carton_id: 3 total_quantity: 1 line_items: - id: 16 quantity: 1 unit_price: 450 total_price: 450 user_product: id: 47242 store_id: 786321 base_product_id: 9 type: null external_product_id: null user_sku: tps_report_1 name: 'TPS Report 1' scale_option: fill description: "A TPS report in it's final format." base_product: id: 9 sku: PP16 name: '16 x 20 Print' product_category: 1 type: poster_sm description: '16x20 Poster Print' properties: ratio: '4:5' width: 16 height: 20 weight: 0.148 paperType: 'Sappi McCoy 80lb/216gsm Coated Cover' thickness: 0.009 ratio_decimal: 0.8 thumbnail: 'https://printops.s3.amazonaws.com/1245/thumbnails/iJL4OAm5btnTf66WLtCZb3eSNNQA5JeUWJwBkT1d.jpg' shipments: [] order_totals: id: 33 line_items_total: 450 fulfillment_total: 300 handling: null shipping_total: 0 subtotal: null tax_total: 0 grand_total: 750 order_notes: [] order_events: [] status: created code: 201 messages: [] properties: data: type: object properties: orders: type: array example: - id: 320117 store_id: 786321 type: standard state: received is_live: null requested_shipping: usps_ground_advantage estimated_ship_date: '2024-02-01' external_order_id: 12003210-ABD30 packing_slip_url: null shipping_label_url: null canceled_at: null closed_at: null cancel_reason: null remote_ip: null total_item_count: null gift_message: null line_items: - id: 16 quantity: 1 unit_price: 450 total_price: 450 scale_option: fit user_product: id: 47242 store_id: 786321 base_product_id: 9 type: null external_product_id: null user_sku: tps_report_1 name: 'TPS Report 1' scale_option: fill description: "A TPS report in it's final format." base_product: id: 9 sku: PP16 name: '16 x 20 Print' product_category: 1 type: poster_sm description: '16x20 Poster Print' properties: ratio: '4:5' width: 16 height: 20 weight: 0.148 paperType: 'Sappi McCoy 80lb/216gsm Coated Cover' thickness: 0.009 ratio_decimal: 0.8 thumbnail: 'https://printops.s3.amazonaws.com/1245/thumbnails/iJL4OAm5btnTf66WLtCZb3eSNNQA5JeUWJwBkT1d.jpg' shipping_address: order_id: null company: Initech first_name: Bill last_name: Lumbergh address_1: '4120 Freidrich Lane' address_2: 'Ste 100' city: Austin state: TX postal_code: '78744' country: US phone: 512-251-5221 fulfillments: - id: 621515 carton_id: 3 total_quantity: 1 line_items: - id: 16 quantity: 1 unit_price: 450 total_price: 450 user_product: id: 47242 store_id: 786321 base_product_id: 9 type: null external_product_id: null user_sku: tps_report_1 name: 'TPS Report 1' scale_option: fill description: "A TPS report in it's final format." base_product: { id: 9, sku: PP16, name: '16 x 20 Print', product_category: 1, type: poster_sm, description: '16x20 Poster Print', properties: { ratio: '4:5', width: 16, height: 20, weight: 0.148, paperType: 'Sappi McCoy 80lb/216gsm Coated Cover', thickness: 0.009, ratio_decimal: 0.8 } } thumbnail: 'https://printops.s3.amazonaws.com/1245/thumbnails/iJL4OAm5btnTf66WLtCZb3eSNNQA5JeUWJwBkT1d.jpg' shipments: [] order_totals: id: 33 line_items_total: 450 fulfillment_total: 300 handling: null shipping_total: 0 subtotal: null tax_total: 0 grand_total: 750 order_notes: [] order_events: [] items: type: object properties: id: type: integer example: 320117 store_id: type: integer example: 786321 type: type: string example: standard state: type: string example: received is_live: type: string example: null requested_shipping: type: string example: usps_ground_advantage estimated_ship_date: type: string example: '2024-02-01' external_order_id: type: string example: 12003210-ABD30 packing_slip_url: type: string example: null shipping_label_url: type: string example: null canceled_at: type: string example: null closed_at: type: string example: null cancel_reason: type: string example: null remote_ip: type: string example: null total_item_count: type: string example: null gift_message: type: string example: null line_items: type: array example: - id: 16 quantity: 1 unit_price: 450 total_price: 450 scale_option: fit user_product: id: 47242 store_id: 786321 base_product_id: 9 type: null external_product_id: null user_sku: tps_report_1 name: 'TPS Report 1' scale_option: fill description: "A TPS report in it's final format." base_product: id: 9 sku: PP16 name: '16 x 20 Print' product_category: 1 type: poster_sm description: '16x20 Poster Print' properties: { ratio: '4:5', width: 16, height: 20, weight: 0.148, paperType: 'Sappi McCoy 80lb/216gsm Coated Cover', thickness: 0.009, ratio_decimal: 0.8 } thumbnail: 'https://printops.s3.amazonaws.com/1245/thumbnails/iJL4OAm5btnTf66WLtCZb3eSNNQA5JeUWJwBkT1d.jpg' items: type: object properties: id: type: integer example: 16 quantity: type: integer example: 1 unit_price: type: integer example: 450 total_price: type: integer example: 450 scale_option: type: string example: fit user_product: type: object properties: id: { type: integer, example: 47242 } store_id: { type: integer, example: 786321 } base_product_id: { type: integer, example: 9 } type: { type: string, example: null } external_product_id: { type: string, example: null } user_sku: { type: string, example: tps_report_1 } name: { type: string, example: 'TPS Report 1' } scale_option: { type: string, example: fill } description: { type: string, example: "A TPS report in it's final format." } base_product: { type: object, properties: { id: { type: integer, example: 9 }, sku: { type: string, example: PP16 }, name: { type: string, example: '16 x 20 Print' }, product_category: { type: integer, example: 1 }, type: { type: string, example: poster_sm }, description: { type: string, example: '16x20 Poster Print' }, properties: { type: object, properties: { ratio: { type: string, example: '4:5' }, width: { type: integer, example: 16 }, height: { type: integer, example: 20 }, weight: { type: number, example: 0.148 }, paperType: { type: string, example: 'Sappi McCoy 80lb/216gsm Coated Cover' }, thickness: { type: number, example: 0.009 }, ratio_decimal: { type: number, example: 0.8 } } } } } thumbnail: { type: string, example: 'https://printops.s3.amazonaws.com/1245/thumbnails/iJL4OAm5btnTf66WLtCZb3eSNNQA5JeUWJwBkT1d.jpg' } shipping_address: type: object properties: order_id: type: string example: null company: type: string example: Initech first_name: type: string example: Bill last_name: type: string example: Lumbergh address_1: type: string example: '4120 Freidrich Lane' address_2: type: string example: 'Ste 100' city: type: string example: Austin state: type: string example: TX postal_code: type: string example: '78744' country: type: string example: US phone: type: string example: 512-251-5221 fulfillments: type: array example: - id: 621515 carton_id: 3 total_quantity: 1 line_items: - id: 16 quantity: 1 unit_price: 450 total_price: 450 user_product: { id: 47242, store_id: 786321, base_product_id: 9, type: null, external_product_id: null, user_sku: tps_report_1, name: 'TPS Report 1', scale_option: fill, description: "A TPS report in it's final format.", base_product: { id: 9, sku: PP16, name: '16 x 20 Print', product_category: 1, type: poster_sm, description: '16x20 Poster Print', properties: { ratio: '4:5', width: 16, height: 20, weight: 0.148, paperType: 'Sappi McCoy 80lb/216gsm Coated Cover', thickness: 0.009, ratio_decimal: 0.8 } }, thumbnail: 'https://printops.s3.amazonaws.com/1245/thumbnails/iJL4OAm5btnTf66WLtCZb3eSNNQA5JeUWJwBkT1d.jpg' } items: type: object properties: id: type: integer example: 621515 carton_id: type: integer example: 3 total_quantity: type: integer example: 1 line_items: type: array example: - { id: 16, quantity: 1, unit_price: 450, total_price: 450, user_product: { id: 47242, store_id: 786321, base_product_id: 9, type: null, external_product_id: null, user_sku: tps_report_1, name: 'TPS Report 1', scale_option: fill, description: "A TPS report in it's final format.", base_product: { id: 9, sku: PP16, name: '16 x 20 Print', product_category: 1, type: poster_sm, description: '16x20 Poster Print', properties: { ratio: '4:5', width: 16, height: 20, weight: 0.148, paperType: 'Sappi McCoy 80lb/216gsm Coated Cover', thickness: 0.009, ratio_decimal: 0.8 } }, thumbnail: 'https://printops.s3.amazonaws.com/1245/thumbnails/iJL4OAm5btnTf66WLtCZb3eSNNQA5JeUWJwBkT1d.jpg' } } items: type: object properties: { id: { type: integer, example: 16 }, quantity: { type: integer, example: 1 }, unit_price: { type: integer, example: 450 }, total_price: { type: integer, example: 450 }, user_product: { type: object, properties: { id: { type: integer, example: 47242 }, store_id: { type: integer, example: 786321 }, base_product_id: { type: integer, example: 9 }, type: { type: string, example: null }, external_product_id: { type: string, example: null }, user_sku: { type: string, example: tps_report_1 }, name: { type: string, example: 'TPS Report 1' }, scale_option: { type: string, example: fill }, description: { type: string, example: "A TPS report in it's final format." }, base_product: { type: object, properties: { id: { type: integer, example: 9 }, sku: { type: string, example: PP16 }, name: { type: string, example: '16 x 20 Print' }, product_category: { type: integer, example: 1 }, type: { type: string, example: poster_sm }, description: { type: string, example: '16x20 Poster Print' }, properties: { type: object, properties: { ratio: { type: string, example: '4:5' }, width: { type: integer, example: 16 }, height: { type: integer, example: 20 }, weight: { type: number, example: 0.148 }, paperType: { type: string, example: 'Sappi McCoy 80lb/216gsm Coated Cover' }, thickness: { type: number, example: 0.009 }, ratio_decimal: { type: number, example: 0.8 } } } } }, thumbnail: { type: string, example: 'https://printops.s3.amazonaws.com/1245/thumbnails/iJL4OAm5btnTf66WLtCZb3eSNNQA5JeUWJwBkT1d.jpg' } } } } shipments: type: array example: [] order_totals: type: object properties: id: type: integer example: 33 line_items_total: type: integer example: 450 fulfillment_total: type: integer example: 300 handling: type: string example: null shipping_total: type: integer example: 0 subtotal: type: string example: null tax_total: type: integer example: 0 grand_total: type: integer example: 750 order_notes: type: array example: [] order_events: type: array example: [] status: type: string example: created code: type: integer example: 201 messages: type: array example: [] tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: external_order_id: type: string description: 'External order id - must be unique.' example: 12003210-ABD30 requested_shipping: type: string description: 'Requested shipping method.' example: usps_ground_advantage shipping_address: type: object description: '' example: [] properties: company: type: string description: 'Shipping address company name.' example: Initech first_name: type: string description: 'Shipping address first name.' example: Bill last_name: type: string description: 'Shipping address last name.' example: Lumbergh address_1: type: string description: 'Shipping address street 1.' example: '4120 Freidrich Lane' address_2: type: string description: 'Shipping address street 2.' example: 'Ste 100' city: type: string description: 'Shipping address city.' example: Austin state: type: string description: 'Shipping address state.' example: TX postal_code: type: string description: 'Shipping address postal_code.' example: '78744' country: type: string description: 'Shipping address country.' example: US phone: type: string description: 'Shipping address phone.' example: 512-251-5221 line_items: type: object description: '' example: [] properties: sku: type: string description: 'Sku number.' example: tps_report_1 quantity: type: integer description: 'Quantity of item.' example: 1 image_url: type: string description: 'Publicly accessible url of image file.' example: 'https://mywebsite.com/images/tps_report_1.jpg' image_name: type: string description: 'The filename of the file.' example: tps_report_1.jpg scale_option: type: string description: 'The scaling option for the file.' example: fit required: - external_order_id - requested_shipping - shipping_address - line_items parameters: - in: path name: store_id description: 'The id of the PrintOps store.' example: 786321 required: true schema: type: integer '/api/stores/{store}/orders': get: summary: 'Get Orders' operationId: getOrders description: 'Get a list of orders from a store.' parameters: - in: query name: page description: 'The page number for pagination.' example: 1 required: false schema: type: integer description: 'The page number for pagination.' example: 1 - in: query name: limit description: 'The number of records to return per page.' example: 2 required: false schema: type: integer description: 'The number of records to return per page.' example: 2 responses: 200: description: '' content: application/json: schema: type: object example: data: orders: - id: 320139 store_id: 786323 type: standard state: shipped is_live: null requested_shipping: usps_ground_advantage estimated_ship_date: '2024-02-13' external_order_id: 12003210-ABD30 packing_slip_url: null shipping_label_url: null canceled_at: null closed_at: null cancel_reason: null remote_ip: null total_item_count: null gift_message: null line_items: - id: 38 quantity: 1 unit_price: 450 total_price: 450 scale_option: null user_product: id: 47244 store_id: 786323 base_product_id: 21 type: null external_product_id: null user_sku: cat_poster_18x18 name: 'Cat Poster 18x18' scale_option: fit description: 'Cute cat poster sized to 18 x 18' base_product: id: 21 sku: SP18 name: '18 x 18 Square Print' product_category: 2 type: poster_sm description: '18x18 Square Poster Print' properties: ratio: '1:1' width: 18 height: 18 weight: 0.15 paperType: 'Sappi McCoy 80lb/216gsm Coated Cover' thickness: 0.009 ratio_decimal: 1 price: '4.50' ships_alone: false thumbnail: 'https://printops.s3.amazonaws.com/1246/thumbnails/1ZCBPAoVSAc9oLdyuNiwz4rzls3pFEALKGOxVGlD.jpg' shipping_address: order_id: null company: Initech first_name: Bill last_name: Lumbergh address_1: '4120 Freidrich Lane' address_2: 'Ste 100' city: Austin state: TX postal_code: '78744' country: US phone: 512-251-5221 fulfillments: - id: 621537 carton_id: 3 total_quantity: 1 line_items: - id: 38 quantity: 1 unit_price: 450 total_price: 450 user_product: id: 47244 store_id: 786323 base_product_id: 21 type: null external_product_id: null user_sku: cat_poster_18x18 name: 'Cat Poster 18x18' scale_option: fit description: 'Cute cat poster sized to 18 x 18' base_product: id: 21 sku: SP18 name: '18 x 18 Square Print' product_category: 2 type: poster_sm description: '18x18 Square Poster Print' properties: ratio: '1:1' width: 18 height: 18 weight: 0.15 paperType: 'Sappi McCoy 80lb/216gsm Coated Cover' thickness: 0.009 ratio_decimal: 1 price: '4.50' ships_alone: false thumbnail: 'https://printops.s3.amazonaws.com/1246/thumbnails/1ZCBPAoVSAc9oLdyuNiwz4rzls3pFEALKGOxVGlD.jpg' shipments: shipments: - id: 4 order_id: 320139 fulfillment_id: 621537 shipping_carrier: UPS shipping_carrier_identifier: ups shipping_method: 'UPS Standard℠' shipping_method_identifier: ups_standard price: 0 tracking_number: 1Z94a6a2035123123 weight: '12.00' voided_on: null created_at: '2024-02-08T23:11:38.000000Z' - id: 10 order_id: 320139 fulfillment_id: 621537 shipping_carrier: UPS shipping_carrier_identifier: ups shipping_method: 'UPS Standard℠' shipping_method_identifier: ups_standard price: 0 tracking_number: 1Z94a6a2035123123 weight: '12.00' voided_on: null created_at: '2024-03-01T17:47:58.000000Z' order_total: id: 113 line_items_total: 450 fulfillment_total: 300 handling: null shipping_total: 567 subtotal: null tax_total: 0 grand_total: 1317 order_notes: [] order_events: [] - id: 320140 store_id: 786323 type: standard state: received is_live: null requested_shipping: usps_ground_advantage estimated_ship_date: '2024-02-14' external_order_id: 12003210-ABD30 packing_slip_url: null shipping_label_url: null canceled_at: null closed_at: null cancel_reason: null remote_ip: null total_item_count: null gift_message: null line_items: - id: 39 quantity: 1 unit_price: 450 total_price: 450 scale_option: null user_product: id: 47244 store_id: 786323 base_product_id: 21 type: null external_product_id: null user_sku: cat_poster_18x18 name: 'Cat Poster 18x18' scale_option: fit description: 'Cute cat poster sized to 18 x 18' base_product: id: 21 sku: SP18 name: '18 x 18 Square Print' product_category: 2 type: poster_sm description: '18x18 Square Poster Print' properties: ratio: '1:1' width: 18 height: 18 weight: 0.15 paperType: 'Sappi McCoy 80lb/216gsm Coated Cover' thickness: 0.009 ratio_decimal: 1 price: '4.50' ships_alone: false thumbnail: 'https://printops.s3.amazonaws.com/1246/thumbnails/1ZCBPAoVSAc9oLdyuNiwz4rzls3pFEALKGOxVGlD.jpg' shipping_address: order_id: null company: Initech first_name: Bill last_name: Lumbergh address_1: '4120 Freidrich Lane' address_2: 'Ste 100' city: Austin state: TX postal_code: '78744' country: US phone: 512-251-5221 fulfillments: - id: 621538 carton_id: 3 total_quantity: 1 line_items: - id: 39 quantity: 1 unit_price: 450 total_price: 450 user_product: id: 47244 store_id: 786323 base_product_id: 21 type: null external_product_id: null user_sku: cat_poster_18x18 name: 'Cat Poster 18x18' scale_option: fit description: 'Cute cat poster sized to 18 x 18' base_product: id: 21 sku: SP18 name: '18 x 18 Square Print' product_category: 2 type: poster_sm description: '18x18 Square Poster Print' properties: ratio: '1:1' width: 18 height: 18 weight: 0.15 paperType: 'Sappi McCoy 80lb/216gsm Coated Cover' thickness: 0.009 ratio_decimal: 1 price: '4.50' ships_alone: false thumbnail: 'https://printops.s3.amazonaws.com/1246/thumbnails/1ZCBPAoVSAc9oLdyuNiwz4rzls3pFEALKGOxVGlD.jpg' shipments: shipments: [] order_total: id: 81 line_items_total: 450 fulfillment_total: 300 handling: null shipping_total: 567 subtotal: null tax_total: 0 grand_total: 1317 order_notes: [] order_events: [] links: first: 'https://printops.test/api/stores/786323/orders?page=1' last: 'https://printops.test/api/stores/786323/orders?page=9' prev: null next: 'https://printops.test/api/stores/786323/orders?page=2' meta: current_page: 1 from: 1 last_page: 9 links: - url: null label: '« Previous' active: false - url: 'https://printops.test/api/stores/786323/orders?page=1' label: '1' active: true - url: 'https://printops.test/api/stores/786323/orders?page=2' label: '2' active: false - url: 'https://printops.test/api/stores/786323/orders?page=3' label: '3' active: false - url: 'https://printops.test/api/stores/786323/orders?page=4' label: '4' active: false - url: 'https://printops.test/api/stores/786323/orders?page=5' label: '5' active: false - url: 'https://printops.test/api/stores/786323/orders?page=6' label: '6' active: false - url: 'https://printops.test/api/stores/786323/orders?page=7' label: '7' active: false - url: 'https://printops.test/api/stores/786323/orders?page=8' label: '8' active: false - url: 'https://printops.test/api/stores/786323/orders?page=9' label: '9' active: false - url: 'https://printops.test/api/stores/786323/orders?page=2' label: 'Next »' active: false path: 'https://printops.test/api/stores/786323/orders' per_page: 2 to: 2 total: 18 status: OK code: 200 messages: [] properties: data: type: object properties: orders: type: array example: - id: 320139 store_id: 786323 type: standard state: shipped is_live: null requested_shipping: usps_ground_advantage estimated_ship_date: '2024-02-13' external_order_id: 12003210-ABD30 packing_slip_url: null shipping_label_url: null canceled_at: null closed_at: null cancel_reason: null remote_ip: null total_item_count: null gift_message: null line_items: - id: 38 quantity: 1 unit_price: 450 total_price: 450 scale_option: null user_product: id: 47244 store_id: 786323 base_product_id: 21 type: null external_product_id: null user_sku: cat_poster_18x18 name: 'Cat Poster 18x18' scale_option: fit description: 'Cute cat poster sized to 18 x 18' base_product: id: 21 sku: SP18 name: '18 x 18 Square Print' product_category: 2 type: poster_sm description: '18x18 Square Poster Print' properties: ratio: '1:1' width: 18 height: 18 weight: 0.15 paperType: 'Sappi McCoy 80lb/216gsm Coated Cover' thickness: 0.009 ratio_decimal: 1 price: '4.50' ships_alone: false thumbnail: 'https://printops.s3.amazonaws.com/1246/thumbnails/1ZCBPAoVSAc9oLdyuNiwz4rzls3pFEALKGOxVGlD.jpg' shipping_address: order_id: null company: Initech first_name: Bill last_name: Lumbergh address_1: '4120 Freidrich Lane' address_2: 'Ste 100' city: Austin state: TX postal_code: '78744' country: US phone: 512-251-5221 fulfillments: - id: 621537 carton_id: 3 total_quantity: 1 line_items: - id: 38 quantity: 1 unit_price: 450 total_price: 450 user_product: id: 47244 store_id: 786323 base_product_id: 21 type: null external_product_id: null user_sku: cat_poster_18x18 name: 'Cat Poster 18x18' scale_option: fit description: 'Cute cat poster sized to 18 x 18' base_product: { id: 21, sku: SP18, name: '18 x 18 Square Print', product_category: 2, type: poster_sm, description: '18x18 Square Poster Print', properties: { ratio: '1:1', width: 18, height: 18, weight: 0.15, paperType: 'Sappi McCoy 80lb/216gsm Coated Cover', thickness: 0.009, ratio_decimal: 1 }, price: '4.50', ships_alone: false } thumbnail: 'https://printops.s3.amazonaws.com/1246/thumbnails/1ZCBPAoVSAc9oLdyuNiwz4rzls3pFEALKGOxVGlD.jpg' shipments: shipments: - id: 4 order_id: 320139 fulfillment_id: 621537 shipping_carrier: UPS shipping_carrier_identifier: ups shipping_method: 'UPS Standard℠' shipping_method_identifier: ups_standard price: 0 tracking_number: 1Z94a6a2035123123 weight: '12.00' voided_on: null created_at: '2024-02-08T23:11:38.000000Z' - id: 10 order_id: 320139 fulfillment_id: 621537 shipping_carrier: UPS shipping_carrier_identifier: ups shipping_method: 'UPS Standard℠' shipping_method_identifier: ups_standard price: 0 tracking_number: 1Z94a6a2035123123 weight: '12.00' voided_on: null created_at: '2024-03-01T17:47:58.000000Z' order_total: id: 113 line_items_total: 450 fulfillment_total: 300 handling: null shipping_total: 567 subtotal: null tax_total: 0 grand_total: 1317 order_notes: [] order_events: [] - id: 320140 store_id: 786323 type: standard state: received is_live: null requested_shipping: usps_ground_advantage estimated_ship_date: '2024-02-14' external_order_id: 12003210-ABD30 packing_slip_url: null shipping_label_url: null canceled_at: null closed_at: null cancel_reason: null remote_ip: null total_item_count: null gift_message: null line_items: - id: 39 quantity: 1 unit_price: 450 total_price: 450 scale_option: null user_product: id: 47244 store_id: 786323 base_product_id: 21 type: null external_product_id: null user_sku: cat_poster_18x18 name: 'Cat Poster 18x18' scale_option: fit description: 'Cute cat poster sized to 18 x 18' base_product: id: 21 sku: SP18 name: '18 x 18 Square Print' product_category: 2 type: poster_sm description: '18x18 Square Poster Print' properties: ratio: '1:1' width: 18 height: 18 weight: 0.15 paperType: 'Sappi McCoy 80lb/216gsm Coated Cover' thickness: 0.009 ratio_decimal: 1 price: '4.50' ships_alone: false thumbnail: 'https://printops.s3.amazonaws.com/1246/thumbnails/1ZCBPAoVSAc9oLdyuNiwz4rzls3pFEALKGOxVGlD.jpg' shipping_address: order_id: null company: Initech first_name: Bill last_name: Lumbergh address_1: '4120 Freidrich Lane' address_2: 'Ste 100' city: Austin state: TX postal_code: '78744' country: US phone: 512-251-5221 fulfillments: - id: 621538 carton_id: 3 total_quantity: 1 line_items: - id: 39 quantity: 1 unit_price: 450 total_price: 450 user_product: id: 47244 store_id: 786323 base_product_id: 21 type: null external_product_id: null user_sku: cat_poster_18x18 name: 'Cat Poster 18x18' scale_option: fit description: 'Cute cat poster sized to 18 x 18' base_product: { id: 21, sku: SP18, name: '18 x 18 Square Print', product_category: 2, type: poster_sm, description: '18x18 Square Poster Print', properties: { ratio: '1:1', width: 18, height: 18, weight: 0.15, paperType: 'Sappi McCoy 80lb/216gsm Coated Cover', thickness: 0.009, ratio_decimal: 1 }, price: '4.50', ships_alone: false } thumbnail: 'https://printops.s3.amazonaws.com/1246/thumbnails/1ZCBPAoVSAc9oLdyuNiwz4rzls3pFEALKGOxVGlD.jpg' shipments: shipments: [] order_total: id: 81 line_items_total: 450 fulfillment_total: 300 handling: null shipping_total: 567 subtotal: null tax_total: 0 grand_total: 1317 order_notes: [] order_events: [] items: type: object properties: id: type: integer example: 320139 store_id: type: integer example: 786323 type: type: string example: standard state: type: string example: shipped is_live: type: string example: null requested_shipping: type: string example: usps_ground_advantage estimated_ship_date: type: string example: '2024-02-13' external_order_id: type: string example: 12003210-ABD30 packing_slip_url: type: string example: null shipping_label_url: type: string example: null canceled_at: type: string example: null closed_at: type: string example: null cancel_reason: type: string example: null remote_ip: type: string example: null total_item_count: type: string example: null gift_message: type: string example: null line_items: type: array example: - id: 38 quantity: 1 unit_price: 450 total_price: 450 scale_option: null user_product: id: 47244 store_id: 786323 base_product_id: 21 type: null external_product_id: null user_sku: cat_poster_18x18 name: 'Cat Poster 18x18' scale_option: fit description: 'Cute cat poster sized to 18 x 18' base_product: id: 21 sku: SP18 name: '18 x 18 Square Print' product_category: 2 type: poster_sm description: '18x18 Square Poster Print' properties: { ratio: '1:1', width: 18, height: 18, weight: 0.15, paperType: 'Sappi McCoy 80lb/216gsm Coated Cover', thickness: 0.009, ratio_decimal: 1 } price: '4.50' ships_alone: false thumbnail: 'https://printops.s3.amazonaws.com/1246/thumbnails/1ZCBPAoVSAc9oLdyuNiwz4rzls3pFEALKGOxVGlD.jpg' items: type: object properties: id: type: integer example: 38 quantity: type: integer example: 1 unit_price: type: integer example: 450 total_price: type: integer example: 450 scale_option: type: string example: null user_product: type: object properties: id: { type: integer, example: 47244 } store_id: { type: integer, example: 786323 } base_product_id: { type: integer, example: 21 } type: { type: string, example: null } external_product_id: { type: string, example: null } user_sku: { type: string, example: cat_poster_18x18 } name: { type: string, example: 'Cat Poster 18x18' } scale_option: { type: string, example: fit } description: { type: string, example: 'Cute cat poster sized to 18 x 18' } base_product: { type: object, properties: { id: { type: integer, example: 21 }, sku: { type: string, example: SP18 }, name: { type: string, example: '18 x 18 Square Print' }, product_category: { type: integer, example: 2 }, type: { type: string, example: poster_sm }, description: { type: string, example: '18x18 Square Poster Print' }, properties: { type: object, properties: { ratio: { type: string, example: '1:1' }, width: { type: integer, example: 18 }, height: { type: integer, example: 18 }, weight: { type: number, example: 0.15 }, paperType: { type: string, example: 'Sappi McCoy 80lb/216gsm Coated Cover' }, thickness: { type: number, example: 0.009 }, ratio_decimal: { type: integer, example: 1 } } }, price: { type: string, example: '4.50' }, ships_alone: { type: boolean, example: false } } } thumbnail: { type: string, example: 'https://printops.s3.amazonaws.com/1246/thumbnails/1ZCBPAoVSAc9oLdyuNiwz4rzls3pFEALKGOxVGlD.jpg' } shipping_address: type: object properties: order_id: type: string example: null company: type: string example: Initech first_name: type: string example: Bill last_name: type: string example: Lumbergh address_1: type: string example: '4120 Freidrich Lane' address_2: type: string example: 'Ste 100' city: type: string example: Austin state: type: string example: TX postal_code: type: string example: '78744' country: type: string example: US phone: type: string example: 512-251-5221 fulfillments: type: array example: - id: 621537 carton_id: 3 total_quantity: 1 line_items: - id: 38 quantity: 1 unit_price: 450 total_price: 450 user_product: { id: 47244, store_id: 786323, base_product_id: 21, type: null, external_product_id: null, user_sku: cat_poster_18x18, name: 'Cat Poster 18x18', scale_option: fit, description: 'Cute cat poster sized to 18 x 18', base_product: { id: 21, sku: SP18, name: '18 x 18 Square Print', product_category: 2, type: poster_sm, description: '18x18 Square Poster Print', properties: { ratio: '1:1', width: 18, height: 18, weight: 0.15, paperType: 'Sappi McCoy 80lb/216gsm Coated Cover', thickness: 0.009, ratio_decimal: 1 }, price: '4.50', ships_alone: false }, thumbnail: 'https://printops.s3.amazonaws.com/1246/thumbnails/1ZCBPAoVSAc9oLdyuNiwz4rzls3pFEALKGOxVGlD.jpg' } items: type: object properties: id: type: integer example: 621537 carton_id: type: integer example: 3 total_quantity: type: integer example: 1 line_items: type: array example: - { id: 38, quantity: 1, unit_price: 450, total_price: 450, user_product: { id: 47244, store_id: 786323, base_product_id: 21, type: null, external_product_id: null, user_sku: cat_poster_18x18, name: 'Cat Poster 18x18', scale_option: fit, description: 'Cute cat poster sized to 18 x 18', base_product: { id: 21, sku: SP18, name: '18 x 18 Square Print', product_category: 2, type: poster_sm, description: '18x18 Square Poster Print', properties: { ratio: '1:1', width: 18, height: 18, weight: 0.15, paperType: 'Sappi McCoy 80lb/216gsm Coated Cover', thickness: 0.009, ratio_decimal: 1 }, price: '4.50', ships_alone: false }, thumbnail: 'https://printops.s3.amazonaws.com/1246/thumbnails/1ZCBPAoVSAc9oLdyuNiwz4rzls3pFEALKGOxVGlD.jpg' } } items: type: object properties: { id: { type: integer, example: 38 }, quantity: { type: integer, example: 1 }, unit_price: { type: integer, example: 450 }, total_price: { type: integer, example: 450 }, user_product: { type: object, properties: { id: { type: integer, example: 47244 }, store_id: { type: integer, example: 786323 }, base_product_id: { type: integer, example: 21 }, type: { type: string, example: null }, external_product_id: { type: string, example: null }, user_sku: { type: string, example: cat_poster_18x18 }, name: { type: string, example: 'Cat Poster 18x18' }, scale_option: { type: string, example: fit }, description: { type: string, example: 'Cute cat poster sized to 18 x 18' }, base_product: { type: object, properties: { id: { type: integer, example: 21 }, sku: { type: string, example: SP18 }, name: { type: string, example: '18 x 18 Square Print' }, product_category: { type: integer, example: 2 }, type: { type: string, example: poster_sm }, description: { type: string, example: '18x18 Square Poster Print' }, properties: { type: object, properties: { ratio: { type: string, example: '1:1' }, width: { type: integer, example: 18 }, height: { type: integer, example: 18 }, weight: { type: number, example: 0.15 }, paperType: { type: string, example: 'Sappi McCoy 80lb/216gsm Coated Cover' }, thickness: { type: number, example: 0.009 }, ratio_decimal: { type: integer, example: 1 } } }, price: { type: string, example: '4.50' }, ships_alone: { type: boolean, example: false } } }, thumbnail: { type: string, example: 'https://printops.s3.amazonaws.com/1246/thumbnails/1ZCBPAoVSAc9oLdyuNiwz4rzls3pFEALKGOxVGlD.jpg' } } } } shipments: type: object properties: shipments: type: array example: - id: 4 order_id: 320139 fulfillment_id: 621537 shipping_carrier: UPS shipping_carrier_identifier: ups shipping_method: 'UPS Standard℠' shipping_method_identifier: ups_standard price: 0 tracking_number: 1Z94a6a2035123123 weight: '12.00' voided_on: null created_at: '2024-02-08T23:11:38.000000Z' - id: 10 order_id: 320139 fulfillment_id: 621537 shipping_carrier: UPS shipping_carrier_identifier: ups shipping_method: 'UPS Standard℠' shipping_method_identifier: ups_standard price: 0 tracking_number: 1Z94a6a2035123123 weight: '12.00' voided_on: null created_at: '2024-03-01T17:47:58.000000Z' items: type: object properties: id: { type: integer, example: 4 } order_id: { type: integer, example: 320139 } fulfillment_id: { type: integer, example: 621537 } shipping_carrier: { type: string, example: UPS } shipping_carrier_identifier: { type: string, example: ups } shipping_method: { type: string, example: 'UPS Standard℠' } shipping_method_identifier: { type: string, example: ups_standard } price: { type: integer, example: 0 } tracking_number: { type: string, example: 1Z94a6a2035123123 } weight: { type: string, example: '12.00' } voided_on: { type: string, example: null } created_at: { type: string, example: '2024-02-08T23:11:38.000000Z' } order_total: type: object properties: id: type: integer example: 113 line_items_total: type: integer example: 450 fulfillment_total: type: integer example: 300 handling: type: string example: null shipping_total: type: integer example: 567 subtotal: type: string example: null tax_total: type: integer example: 0 grand_total: type: integer example: 1317 order_notes: type: array example: [] order_events: type: array example: [] links: type: object properties: first: type: string example: 'https://printops.test/api/stores/786323/orders?page=1' last: type: string example: 'https://printops.test/api/stores/786323/orders?page=9' prev: type: string example: null next: type: string example: 'https://printops.test/api/stores/786323/orders?page=2' meta: type: object properties: current_page: type: integer example: 1 from: type: integer example: 1 last_page: type: integer example: 9 links: type: array example: - url: null label: '« Previous' active: false - url: 'https://printops.test/api/stores/786323/orders?page=1' label: '1' active: true - url: 'https://printops.test/api/stores/786323/orders?page=2' label: '2' active: false - url: 'https://printops.test/api/stores/786323/orders?page=3' label: '3' active: false - url: 'https://printops.test/api/stores/786323/orders?page=4' label: '4' active: false - url: 'https://printops.test/api/stores/786323/orders?page=5' label: '5' active: false - url: 'https://printops.test/api/stores/786323/orders?page=6' label: '6' active: false - url: 'https://printops.test/api/stores/786323/orders?page=7' label: '7' active: false - url: 'https://printops.test/api/stores/786323/orders?page=8' label: '8' active: false - url: 'https://printops.test/api/stores/786323/orders?page=9' label: '9' active: false - url: 'https://printops.test/api/stores/786323/orders?page=2' label: 'Next »' active: false items: type: object properties: url: type: string example: null label: type: string example: '« Previous' active: type: boolean example: false path: type: string example: 'https://printops.test/api/stores/786323/orders' per_page: type: integer example: 2 to: type: integer example: 2 total: type: integer example: 18 status: type: string example: OK code: type: integer example: 200 messages: type: array example: [] tags: - Endpoints parameters: - in: path name: store description: 'Optional parameter. The id of the store.' required: true schema: type: integer examples: omitted: summary: 'When the value is omitted' value: '' present: summary: 'When the value is present' value: 786323 '/api/stores/{store}/orders/{order}': get: summary: 'Get an Order by Id' operationId: getAnOrderById description: 'Get a single order by order id.' parameters: [] responses: 200: description: '' content: application/json: schema: type: object example: data: order: id: 320139 store_id: 786323 type: standard state: shipped is_live: null requested_shipping: usps_ground_advantage estimated_ship_date: '2024-02-13' external_order_id: 12003210-ABD30 packing_slip_url: null shipping_label_url: null canceled_at: null closed_at: null cancel_reason: null remote_ip: null total_item_count: null gift_message: null line_items: - id: 38 quantity: 1 unit_price: 450 total_price: 450 scale_option: null user_product: id: 47244 store_id: 786323 base_product_id: 21 type: null external_product_id: null user_sku: cat_poster_18x18 name: 'Cat Poster 18x18' scale_option: fit description: 'Cute cat poster sized to 18 x 18' base_product: id: 21 sku: SP18 name: '18 x 18 Square Print' product_category: 2 type: poster_sm description: '18x18 Square Poster Print' properties: ratio: '1:1' width: 18 height: 18 weight: 0.15 paperType: 'Sappi McCoy 80lb/216gsm Coated Cover' thickness: 0.009 ratio_decimal: 1 price: '4.50' ships_alone: false thumbnail: 'https://printops.s3.amazonaws.com/1246/thumbnails/1ZCBPAoVSAc9oLdyuNiwz4rzls3pFEALKGOxVGlD.jpg' shipping_address: order_id: null company: Initech first_name: Bill last_name: Lumbergh address_1: '4120 Freidrich Lane' address_2: 'Ste 100' city: Austin state: TX postal_code: '78744' country: US phone: 512-251-5221 fulfillments: - id: 621537 carton_id: 3 total_quantity: 1 line_items: - id: 38 quantity: 1 unit_price: 450 total_price: 450 user_product: id: 47244 store_id: 786323 base_product_id: 21 type: null external_product_id: null user_sku: cat_poster_18x18 name: 'Cat Poster 18x18' scale_option: fit description: 'Cute cat poster sized to 18 x 18' base_product: id: 21 sku: SP18 name: '18 x 18 Square Print' product_category: 2 type: poster_sm description: '18x18 Square Poster Print' properties: ratio: '1:1' width: 18 height: 18 weight: 0.15 paperType: 'Sappi McCoy 80lb/216gsm Coated Cover' thickness: 0.009 ratio_decimal: 1 price: '4.50' ships_alone: false thumbnail: 'https://printops.s3.amazonaws.com/1246/thumbnails/1ZCBPAoVSAc9oLdyuNiwz4rzls3pFEALKGOxVGlD.jpg' shipments: shipments: - id: 4 order_id: 320139 fulfillment_id: 621537 shipping_carrier: UPS shipping_carrier_identifier: ups shipping_method: 'UPS Standard℠' shipping_method_identifier: ups_standard price: 0 tracking_number: 1Z94a6a2035123123 weight: '12.00' voided_on: null created_at: '2024-02-08T23:11:38.000000Z' - id: 10 order_id: 320139 fulfillment_id: 621537 shipping_carrier: UPS shipping_carrier_identifier: ups shipping_method: 'UPS Standard℠' shipping_method_identifier: ups_standard price: 0 tracking_number: 1Z94a6a2035123123 weight: '12.00' voided_on: null created_at: '2024-03-01T17:47:58.000000Z' order_total: id: 113 line_items_total: 450 fulfillment_total: 300 handling: null shipping_total: 567 subtotal: null tax_total: 0 grand_total: 1317 order_notes: [] order_events: [] status: OK code: 200 messages: [] properties: data: type: object properties: order: type: object properties: id: type: integer example: 320139 store_id: type: integer example: 786323 type: type: string example: standard state: type: string example: shipped is_live: type: string example: null requested_shipping: type: string example: usps_ground_advantage estimated_ship_date: type: string example: '2024-02-13' external_order_id: type: string example: 12003210-ABD30 packing_slip_url: type: string example: null shipping_label_url: type: string example: null canceled_at: type: string example: null closed_at: type: string example: null cancel_reason: type: string example: null remote_ip: type: string example: null total_item_count: type: string example: null gift_message: type: string example: null line_items: type: array example: - id: 38 quantity: 1 unit_price: 450 total_price: 450 scale_option: null user_product: id: 47244 store_id: 786323 base_product_id: 21 type: null external_product_id: null user_sku: cat_poster_18x18 name: 'Cat Poster 18x18' scale_option: fit description: 'Cute cat poster sized to 18 x 18' base_product: id: 21 sku: SP18 name: '18 x 18 Square Print' product_category: 2 type: poster_sm description: '18x18 Square Poster Print' properties: ratio: '1:1' width: 18 height: 18 weight: 0.15 paperType: 'Sappi McCoy 80lb/216gsm Coated Cover' thickness: 0.009 ratio_decimal: 1 price: '4.50' ships_alone: false thumbnail: 'https://printops.s3.amazonaws.com/1246/thumbnails/1ZCBPAoVSAc9oLdyuNiwz4rzls3pFEALKGOxVGlD.jpg' items: type: object properties: id: type: integer example: 38 quantity: type: integer example: 1 unit_price: type: integer example: 450 total_price: type: integer example: 450 scale_option: type: string example: null user_product: type: object properties: id: type: integer example: 47244 store_id: type: integer example: 786323 base_product_id: type: integer example: 21 type: type: string example: null external_product_id: type: string example: null user_sku: type: string example: cat_poster_18x18 name: type: string example: 'Cat Poster 18x18' scale_option: type: string example: fit description: type: string example: 'Cute cat poster sized to 18 x 18' base_product: type: object properties: { id: { type: integer, example: 21 }, sku: { type: string, example: SP18 }, name: { type: string, example: '18 x 18 Square Print' }, product_category: { type: integer, example: 2 }, type: { type: string, example: poster_sm }, description: { type: string, example: '18x18 Square Poster Print' }, properties: { type: object, properties: { ratio: { type: string, example: '1:1' }, width: { type: integer, example: 18 }, height: { type: integer, example: 18 }, weight: { type: number, example: 0.15 }, paperType: { type: string, example: 'Sappi McCoy 80lb/216gsm Coated Cover' }, thickness: { type: number, example: 0.009 }, ratio_decimal: { type: integer, example: 1 } } }, price: { type: string, example: '4.50' }, ships_alone: { type: boolean, example: false } } thumbnail: type: string example: 'https://printops.s3.amazonaws.com/1246/thumbnails/1ZCBPAoVSAc9oLdyuNiwz4rzls3pFEALKGOxVGlD.jpg' shipping_address: type: object properties: order_id: type: string example: null company: type: string example: Initech first_name: type: string example: Bill last_name: type: string example: Lumbergh address_1: type: string example: '4120 Freidrich Lane' address_2: type: string example: 'Ste 100' city: type: string example: Austin state: type: string example: TX postal_code: type: string example: '78744' country: type: string example: US phone: type: string example: 512-251-5221 fulfillments: type: array example: - id: 621537 carton_id: 3 total_quantity: 1 line_items: - id: 38 quantity: 1 unit_price: 450 total_price: 450 user_product: id: 47244 store_id: 786323 base_product_id: 21 type: null external_product_id: null user_sku: cat_poster_18x18 name: 'Cat Poster 18x18' scale_option: fit description: 'Cute cat poster sized to 18 x 18' base_product: { id: 21, sku: SP18, name: '18 x 18 Square Print', product_category: 2, type: poster_sm, description: '18x18 Square Poster Print', properties: { ratio: '1:1', width: 18, height: 18, weight: 0.15, paperType: 'Sappi McCoy 80lb/216gsm Coated Cover', thickness: 0.009, ratio_decimal: 1 }, price: '4.50', ships_alone: false } thumbnail: 'https://printops.s3.amazonaws.com/1246/thumbnails/1ZCBPAoVSAc9oLdyuNiwz4rzls3pFEALKGOxVGlD.jpg' items: type: object properties: id: type: integer example: 621537 carton_id: type: integer example: 3 total_quantity: type: integer example: 1 line_items: type: array example: - id: 38 quantity: 1 unit_price: 450 total_price: 450 user_product: { id: 47244, store_id: 786323, base_product_id: 21, type: null, external_product_id: null, user_sku: cat_poster_18x18, name: 'Cat Poster 18x18', scale_option: fit, description: 'Cute cat poster sized to 18 x 18', base_product: { id: 21, sku: SP18, name: '18 x 18 Square Print', product_category: 2, type: poster_sm, description: '18x18 Square Poster Print', properties: { ratio: '1:1', width: 18, height: 18, weight: 0.15, paperType: 'Sappi McCoy 80lb/216gsm Coated Cover', thickness: 0.009, ratio_decimal: 1 }, price: '4.50', ships_alone: false }, thumbnail: 'https://printops.s3.amazonaws.com/1246/thumbnails/1ZCBPAoVSAc9oLdyuNiwz4rzls3pFEALKGOxVGlD.jpg' } items: type: object properties: id: { type: integer, example: 38 } quantity: { type: integer, example: 1 } unit_price: { type: integer, example: 450 } total_price: { type: integer, example: 450 } user_product: { type: object, properties: { id: { type: integer, example: 47244 }, store_id: { type: integer, example: 786323 }, base_product_id: { type: integer, example: 21 }, type: { type: string, example: null }, external_product_id: { type: string, example: null }, user_sku: { type: string, example: cat_poster_18x18 }, name: { type: string, example: 'Cat Poster 18x18' }, scale_option: { type: string, example: fit }, description: { type: string, example: 'Cute cat poster sized to 18 x 18' }, base_product: { type: object, properties: { id: { type: integer, example: 21 }, sku: { type: string, example: SP18 }, name: { type: string, example: '18 x 18 Square Print' }, product_category: { type: integer, example: 2 }, type: { type: string, example: poster_sm }, description: { type: string, example: '18x18 Square Poster Print' }, properties: { type: object, properties: { ratio: { type: string, example: '1:1' }, width: { type: integer, example: 18 }, height: { type: integer, example: 18 }, weight: { type: number, example: 0.15 }, paperType: { type: string, example: 'Sappi McCoy 80lb/216gsm Coated Cover' }, thickness: { type: number, example: 0.009 }, ratio_decimal: { type: integer, example: 1 } } }, price: { type: string, example: '4.50' }, ships_alone: { type: boolean, example: false } } }, thumbnail: { type: string, example: 'https://printops.s3.amazonaws.com/1246/thumbnails/1ZCBPAoVSAc9oLdyuNiwz4rzls3pFEALKGOxVGlD.jpg' } } } shipments: type: object properties: shipments: type: array example: - id: 4 order_id: 320139 fulfillment_id: 621537 shipping_carrier: UPS shipping_carrier_identifier: ups shipping_method: 'UPS Standard℠' shipping_method_identifier: ups_standard price: 0 tracking_number: 1Z94a6a2035123123 weight: '12.00' voided_on: null created_at: '2024-02-08T23:11:38.000000Z' - id: 10 order_id: 320139 fulfillment_id: 621537 shipping_carrier: UPS shipping_carrier_identifier: ups shipping_method: 'UPS Standard℠' shipping_method_identifier: ups_standard price: 0 tracking_number: 1Z94a6a2035123123 weight: '12.00' voided_on: null created_at: '2024-03-01T17:47:58.000000Z' items: type: object properties: id: type: integer example: 4 order_id: type: integer example: 320139 fulfillment_id: type: integer example: 621537 shipping_carrier: type: string example: UPS shipping_carrier_identifier: type: string example: ups shipping_method: type: string example: 'UPS Standard℠' shipping_method_identifier: type: string example: ups_standard price: type: integer example: 0 tracking_number: type: string example: 1Z94a6a2035123123 weight: type: string example: '12.00' voided_on: type: string example: null created_at: type: string example: '2024-02-08T23:11:38.000000Z' order_total: type: object properties: id: type: integer example: 113 line_items_total: type: integer example: 450 fulfillment_total: type: integer example: 300 handling: type: string example: null shipping_total: type: integer example: 567 subtotal: type: string example: null tax_total: type: integer example: 0 grand_total: type: integer example: 1317 order_notes: type: array example: [] order_events: type: array example: [] status: type: string example: OK code: type: integer example: 200 messages: type: array example: [] tags: - Endpoints parameters: - in: path name: store description: 'Optional parameter. The id of the store.' required: true schema: type: integer examples: omitted: summary: 'When the value is omitted' value: '' present: summary: 'When the value is present' value: 786323 - in: path name: order description: 'Optional parameter. The id of the order.' required: true schema: type: integer examples: omitted: summary: 'When the value is omitted' value: '' present: summary: 'When the value is present' value: 320139 '/api/stores/{store}/orders/{order}/cancel': post: summary: 'Request to cancel an Order' operationId: requestToCancelAnOrder description: 'This is a request to cancel an order. Depending on the state of the order, it may or may not be able to be canceled.' parameters: [] responses: 201: description: '' content: application/json: schema: type: object example: data: message: 'Cancellation request received.' status: OK code: 200 messages: [] properties: data: type: object properties: message: type: string example: 'Cancellation request received.' status: type: string example: OK code: type: integer example: 200 messages: type: array example: [] tags: - Endpoints parameters: - in: path name: store description: 'The store.' example: 786321 required: true schema: type: integer - in: path name: order description: 'The order.' example: 320100 required: true schema: type: integer '/api/stores/{store}/shipments': get: summary: 'Get Shipments' operationId: getShipments description: 'Get a list of shipments from a particular store.' parameters: - in: query name: page description: 'The page number for pagination.' example: 1 required: false schema: type: integer description: 'The page number for pagination.' example: 1 - in: query name: limit description: 'The number of records to return per page.' example: 2 required: false schema: type: integer description: 'The number of records to return per page.' example: 2 responses: 200: description: '' content: application/json: schema: type: object example: data: shipments: - id: 4 order_id: 320139 fulfillment_id: 621537 shipping_carrier: UPS shipping_carrier_identifier: ups shipping_method: 'UPS Standard℠' shipping_method_identifier: ups_standard price: 0 tracking_number: 1Z94a6a2035123123 weight: '12.00' voided_on: null created_at: '2024-02-08T23:11:38.000000Z' - id: 5 order_id: 320155 fulfillment_id: 621550 shipping_carrier: UPS shipping_carrier_identifier: ups shipping_method: 'UPS Standard℠' shipping_method_identifier: ups_standard price: 0 tracking_number: 1Z94a6a2035123123 weight: '12.00' voided_on: null created_at: '2024-02-28T21:48:52.000000Z' links: first: 'https://printops.test/api/stores/786323/shipments?page=1' last: 'https://printops.test/api/stores/786323/shipments?page=4' prev: null next: 'https://printops.test/api/stores/786323/shipments?page=2' meta: current_page: 1 from: 1 last_page: 4 links: - url: null label: '« Previous' active: false - url: 'https://printops.test/api/stores/786323/shipments?page=1' label: '1' active: true - url: 'https://printops.test/api/stores/786323/shipments?page=2' label: '2' active: false - url: 'https://printops.test/api/stores/786323/shipments?page=3' label: '3' active: false - url: 'https://printops.test/api/stores/786323/shipments?page=4' label: '4' active: false - url: 'https://printops.test/api/stores/786323/shipments?page=2' label: 'Next »' active: false path: 'https://printops.test/api/stores/786323/shipments' per_page: 2 to: 2 total: 7 status: OK code: 200 messages: [] properties: data: type: object properties: shipments: type: array example: - id: 4 order_id: 320139 fulfillment_id: 621537 shipping_carrier: UPS shipping_carrier_identifier: ups shipping_method: 'UPS Standard℠' shipping_method_identifier: ups_standard price: 0 tracking_number: 1Z94a6a2035123123 weight: '12.00' voided_on: null created_at: '2024-02-08T23:11:38.000000Z' - id: 5 order_id: 320155 fulfillment_id: 621550 shipping_carrier: UPS shipping_carrier_identifier: ups shipping_method: 'UPS Standard℠' shipping_method_identifier: ups_standard price: 0 tracking_number: 1Z94a6a2035123123 weight: '12.00' voided_on: null created_at: '2024-02-28T21:48:52.000000Z' items: type: object properties: id: type: integer example: 4 order_id: type: integer example: 320139 fulfillment_id: type: integer example: 621537 shipping_carrier: type: string example: UPS shipping_carrier_identifier: type: string example: ups shipping_method: type: string example: 'UPS Standard℠' shipping_method_identifier: type: string example: ups_standard price: type: integer example: 0 tracking_number: type: string example: 1Z94a6a2035123123 weight: type: string example: '12.00' voided_on: type: string example: null created_at: type: string example: '2024-02-08T23:11:38.000000Z' links: type: object properties: first: type: string example: 'https://printops.test/api/stores/786323/shipments?page=1' last: type: string example: 'https://printops.test/api/stores/786323/shipments?page=4' prev: type: string example: null next: type: string example: 'https://printops.test/api/stores/786323/shipments?page=2' meta: type: object properties: current_page: type: integer example: 1 from: type: integer example: 1 last_page: type: integer example: 4 links: type: array example: - url: null label: '« Previous' active: false - url: 'https://printops.test/api/stores/786323/shipments?page=1' label: '1' active: true - url: 'https://printops.test/api/stores/786323/shipments?page=2' label: '2' active: false - url: 'https://printops.test/api/stores/786323/shipments?page=3' label: '3' active: false - url: 'https://printops.test/api/stores/786323/shipments?page=4' label: '4' active: false - url: 'https://printops.test/api/stores/786323/shipments?page=2' label: 'Next »' active: false items: type: object properties: url: type: string example: null label: type: string example: '« Previous' active: type: boolean example: false path: type: string example: 'https://printops.test/api/stores/786323/shipments' per_page: type: integer example: 2 to: type: integer example: 2 total: type: integer example: 7 status: type: string example: OK code: type: integer example: 200 messages: type: array example: [] tags: - Endpoints parameters: - in: path name: store description: 'Optional parameter. The id of the store.' required: true schema: type: integer examples: omitted: summary: 'When the value is omitted' value: '' present: summary: 'When the value is present' value: 786323 '/api/stores/{store}/shipments/{shipment}': get: summary: 'Get a Shipment by Id' operationId: getAShipmentById description: 'Retrieve a particular shipment by id.' parameters: [] responses: 200: description: '' content: application/json: schema: type: object example: data: shipment: id: 4 order_id: 320139 fulfillment_id: 621537 shipping_carrier: UPS shipping_carrier_identifier: ups shipping_method: 'UPS Standard℠' shipping_method_identifier: ups_standard price: 0 tracking_number: 1Z94a6a2035123123 weight: '12.00' voided_on: null created_at: '2024-02-08T23:11:38.000000Z' status: OK code: 200 messages: [] properties: data: type: object properties: shipment: type: object properties: id: type: integer example: 4 order_id: type: integer example: 320139 fulfillment_id: type: integer example: 621537 shipping_carrier: type: string example: UPS shipping_carrier_identifier: type: string example: ups shipping_method: type: string example: 'UPS Standard℠' shipping_method_identifier: type: string example: ups_standard price: type: integer example: 0 tracking_number: type: string example: 1Z94a6a2035123123 weight: type: string example: '12.00' voided_on: type: string example: null created_at: type: string example: '2024-02-08T23:11:38.000000Z' status: type: string example: OK code: type: integer example: 200 messages: type: array example: [] tags: - Endpoints parameters: - in: path name: store description: 'Optional parameter. The id of the store.' required: true schema: type: integer examples: omitted: summary: 'When the value is omitted' value: '' present: summary: 'When the value is present' value: 786323 - in: path name: shipment description: 'Optional parameter. The id of the shipment.' required: true schema: type: integer examples: omitted: summary: 'When the value is omitted' value: '' present: summary: 'When the value is present' value: 4 /api/webhooks: get: summary: 'Get Webhooks' operationId: getWebhooks description: 'Webhooks allow you to subscribe to certain events during the order process.' parameters: [] responses: 200: description: '' content: application/json: schema: type: object example: data: webhooks: - id: 3 is_active: 1 type: order_state_update created_at: '2024-02-28T16:53:16.000000Z' updated_at: '2024-02-28T22:06:57.000000Z' - id: 14 is_active: 1 type: order_shipment created_at: '2024-03-06T16:21:25.000000Z' updated_at: '2024-03-06T16:21:25.000000Z' links: first: 'https://printops.test/api/webhooks?page=1' last: 'https://printops.test/api/webhooks?page=1' prev: null next: null meta: current_page: 1 from: 1 last_page: 1 links: - url: null label: '« Previous' active: false - url: 'https://printops.test/api/webhooks?page=1' label: '1' active: true - url: null label: 'Next »' active: false path: 'https://printops.test/api/webhooks' per_page: 15 to: 2 total: 2 status: OK code: 200 messages: [] properties: data: type: object properties: webhooks: type: array example: - id: 3 is_active: 1 type: order_state_update created_at: '2024-02-28T16:53:16.000000Z' updated_at: '2024-02-28T22:06:57.000000Z' - id: 14 is_active: 1 type: order_shipment created_at: '2024-03-06T16:21:25.000000Z' updated_at: '2024-03-06T16:21:25.000000Z' items: type: object properties: id: type: integer example: 3 is_active: type: integer example: 1 type: type: string example: order_state_update created_at: type: string example: '2024-02-28T16:53:16.000000Z' updated_at: type: string example: '2024-02-28T22:06:57.000000Z' links: type: object properties: first: type: string example: 'https://printops.test/api/webhooks?page=1' last: type: string example: 'https://printops.test/api/webhooks?page=1' prev: type: string example: null next: type: string example: null meta: type: object properties: current_page: type: integer example: 1 from: type: integer example: 1 last_page: type: integer example: 1 links: type: array example: - url: null label: '« Previous' active: false - url: 'https://printops.test/api/webhooks?page=1' label: '1' active: true - url: null label: 'Next »' active: false items: type: object properties: url: type: string example: null label: type: string example: '« Previous' active: type: boolean example: false path: type: string example: 'https://printops.test/api/webhooks' per_page: type: integer example: 15 to: type: integer example: 2 total: type: integer example: 2 status: type: string example: OK code: type: integer example: 200 messages: type: array example: [] tags: - Endpoints post: summary: 'Create a Webhook' operationId: createAWebhook description: '' parameters: [] responses: 201: description: '' content: application/json: schema: type: object example: data: id: 9 is_active: true type: order_shipment created_at: '2024-02-29T20:19:42.000000Z' updated_at: '2024-02-29T20:19:42.000000Z' status: created code: 201 messages: [] properties: data: type: object properties: id: type: integer example: 9 is_active: type: boolean example: true type: type: string example: order_shipment created_at: type: string example: '2024-02-29T20:19:42.000000Z' updated_at: type: string example: '2024-02-29T20:19:42.000000Z' status: type: string example: created code: type: integer example: 201 messages: type: array example: [] tags: - Endpoints requestBody: required: false content: application/json: schema: type: object properties: type: type: string description: 'The type of webhook.' example: order_shipment is_active: type: string description: 'If the webhook is active or not.' example: 'true' '/api/webhooks/{webhook}': get: summary: 'Get a Webhook by Id' operationId: getAWebhookById description: 'Retrieve a webhook by id.' parameters: - in: query name: page description: 'The page number for pagination.' example: 1 required: false schema: type: integer description: 'The page number for pagination.' example: 1 - in: query name: limit description: 'The number of records to return per page.' example: 2 required: false schema: type: integer description: 'The number of records to return per page.' example: 2 responses: 200: description: '' content: application/json: schema: type: object example: data: webhook: id: 14 is_active: 1 type: order_shipment created_at: '2024-03-06T16:21:25.000000Z' updated_at: '2024-03-06T16:21:25.000000Z' status: OK code: 200 messages: [] properties: data: type: object properties: webhook: type: object properties: id: type: integer example: 14 is_active: type: integer example: 1 type: type: string example: order_shipment created_at: type: string example: '2024-03-06T16:21:25.000000Z' updated_at: type: string example: '2024-03-06T16:21:25.000000Z' status: type: string example: OK code: type: integer example: 200 messages: type: array example: [] tags: - Endpoints delete: summary: 'Delete a Webhook' operationId: deleteAWebhook description: '' parameters: [] responses: 200: description: '' content: application/json: schema: type: object example: data: message: 'Webhook deleted' status: Success code: 200 messages: [] properties: data: type: object properties: message: type: string example: 'Webhook deleted' status: type: string example: Success code: type: integer example: 200 messages: type: array example: [] tags: - Endpoints parameters: - in: path name: webhook description: 'The id of the webhook.' example: '14' required: true schema: type: string tags: - name: Endpoints description: '' components: securitySchemes: default: type: http scheme: bearer description: 'You can retrieve your token by visiting the settings page within your dashboard and selecting the API tab. The, just click the Create New Token button. Once a token is created you will need to immediately copy it down - it is only visible for this brief period.' security: - default: []