{"openapi":"3.0.1","x-mcp":{"enabled":true},"info":{"title":"ShipBob Developer API (2.0)","description":"","version":"2.0"},"servers":[{"url":"https://api.shipbob.com"},{"url":"https://sandbox-api.shipbob.com"}],"paths":{"/2.0/webhook":{"post":{"summary":"Create a new webhook subscription\n","parameters":[{"name":"shipbob_channel_id","in":"header","description":"","schema":{"$ref":"#/components/schemas/Webhooks.Post.1.0.Webhook.Shipbob.Channel.Id.Integer"}}],"responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webhooks.Create.WebhookViewModel"},"examples":{"default":{"summary":"","description":"","value":{"created_at":"2019-08-24T14:15:22+00:00","id":12345,"subscription_url":"http://example.com","topic":"order_shipped"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webhooks.Post.1.0.Webhook.Bad.Request.Object"},"examples":{"default":{"summary":"","description":"","value":{"property1":["string"],"property2":["string"]}}}}}},"401":{"description":"No access right at this time"},"403":{"description":"No access"},"422":{"description":"Client Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webhooks.Post.1.0.Webhook.Unprocessable.Entity.Object"},"examples":{"default":{"summary":"","description":"","value":{"property1":["string"],"property2":["string"]}}}}}}},"requestBody":{"description":"","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/Webhooks.CreateWebhookSubscriptionModel"},"examples":{"default":{"summary":"","description":"","value":{"subscription_url":"https://mywebsite.com/shipbob/handler","topic":"order_shipped"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/Webhooks.CreateWebhookSubscriptionModel"},"examples":{"default":{"summary":"","description":"","value":{"subscription_url":"https://mywebsite.com/shipbob/handler","topic":"order_shipped"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/Webhooks.CreateWebhookSubscriptionModel"},"examples":{"default":{"summary":"","description":"","value":{"subscription_url":"https://mywebsite.com/shipbob/handler","topic":"order_shipped"}}}},"application/*+json":{"schema":{"$ref":"#/components/schemas/Webhooks.CreateWebhookSubscriptionModel"},"examples":{"default":{"summary":"","description":"","value":{"subscription_url":"https://mywebsite.com/shipbob/handler","topic":"order_shipped"}}}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Webhooks"]},"get":{"summary":"Get Webhooks\n","description":"All parameters are AND filters\n","parameters":[{"name":"Topic","in":"query","description":"Topic of the webhooks requested\n","schema":{"$ref":"#/components/schemas/Webhooks.Topics"},"examples":{"default":{"summary":"","description":"","value":"order_shipped"}}},{"name":"Page","in":"query","description":"Page of Webhooks to get\n","schema":{"$ref":"#/components/schemas/Webhooks.Get.1.0.Webhook.Page.Integer"},"examples":{"default":{"summary":"","description":"","value":2147483647}}},{"name":"Limit","in":"query","description":"Amount of Webhooks per page to request\n","schema":{"$ref":"#/components/schemas/Webhooks.Get.1.0.Webhook.Limit.Integer"},"examples":{"default":{"summary":"","description":"","value":1}}}],"responses":{"200":{"description":"Success","headers":{"Page-Number":{"description":"Number of the current page\n","schema":{"$ref":"#/components/schemas/Webhooks.Get.1.0.Webhook.OK.Page.Number.Integer"}},"Total-Pages":{"description":"Total number of pages of results\n","schema":{"$ref":"#/components/schemas/Webhooks.Get.1.0.Webhook.OK.Total.Pages.Integer"}},"Total-Count":{"description":"Total number of results\n","schema":{"$ref":"#/components/schemas/Webhooks.Get.1.0.Webhook.OK.Total.Count.Integer"}},"Page-Size":{"description":"Number of results per page\n","schema":{"$ref":"#/components/schemas/Webhooks.Get.1.0.Webhook.OK.Page.Size.Integer"}},"Next-Page":{"description":"The href of the next page of results, if there is a next page\n","schema":{"$ref":"#/components/schemas/Webhooks.Get.1.0.Webhook.OK.Next.Page.String"},"examples":{"default":{"summary":"","description":"","value":"string"}}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webhooks.WebhookViewModelArray"},"examples":{"default":{"summary":"","description":"","value":[{"created_at":"2019-08-24T14:15:22+00:00","enabled":true,"id":12345,"subscription_url":"http://example.com","topic":"order_shipped"}]}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webhooks.Get.1.0.Webhook.Bad.Request.Object"},"examples":{"default":{"summary":"","description":"","value":{"property1":["string"],"property2":["string"]}}}}}},"401":{"description":"No access right at this time"},"403":{"description":"No access"}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Webhooks"]}},"/2.0/webhook/{id}":{"delete":{"summary":"Delete an existing webhook subscription","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"$ref":"#/components/schemas/Webhooks.Delete.1.0.Webhook.Id.Id.Integer"}}],"responses":{"204":{"description":"Success"},"401":{"description":"No access right at this time"},"403":{"description":"No access"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webhooks.Delete.1.0.Webhook.Id.Not.Found.OneOf.HttpValidationProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"$type":"string","detail":"string","errors":{"property1":["string"],"property2":["string"]},"extensions":{"property1":{},"property2":{}},"instance":"string","status":0,"title":"string","type":"string"}}}}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Webhooks"]}},"/2.0/order/{orderId}/shipment/{shipmentId}/cancel":{"post":{"summary":"Cancel one Shipment by Order Id and Shipment Id","parameters":[{"name":"shipmentId","in":"path","description":"The shipment id to get","required":true,"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Order.OrderId.Shipment.ShipmentId.Cancel.ShipmentId.Integer"}},{"name":"orderId","in":"path","description":"","required":true,"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Order.OrderId.Shipment.ShipmentId.Cancel.OrderId.String"},"examples":{"default":{"summary":"","description":"","value":"string"}}},{"name":"shipbob_channel_id","in":"header","description":"Channel Id for Operation","schema":{"$ref":"#/components/schemas/Orders.Post.Api.Order.OrderId.Shipment.ShipmentId.Cancel.Shipbob.Channel.Id.Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Order.OrderId.Shipment.ShipmentId.Cancel.OK.OneOf.ShipmentViewModel.InternalShipmentViewModel"},"examples":{"default":{"summary":"","description":"","value":{"actual_fulfillment_date":"2019-08-24T14:15:22+00:00","created_date":"2019-08-24T14:15:22+00:00","delivery_date":"2019-08-24T14:15:22+00:00","estimated_fulfillment_date":"2019-08-24T14:15:22+00:00","estimated_fulfillment_date_status":"AwaitingInventoryAllocation","gift_message":"string","id":0,"insurance_value":0,"invoice_amount":0,"invoice_currency_code":"string","is_tracking_uploaded":true,"last_tracking_update_at":"2019-08-24T14:15:22+00:00","last_update_at":"2019-08-24T14:15:22+00:00","location":{"id":0,"name":"Cicero (IL)"},"measurements":{"depth_in":0,"length_in":0,"total_weight_oz":0,"width_in":0},"order_id":0,"package_material_type":"Unknown","parent_cartons":[{"barcode":"string","cartons":[{"barcode":"string","carton_details":[{"products":[{"id":0,"inventory_items":[{"expiration_date":"2019-08-24T14:15:22+00:00","id":0,"is_dangerous_goods":true,"lot":"22222","name":"Medium Blue T-Shirt","quantity":0,"quantity_committed":0,"serial_numbers":["string"]}],"name":"Medium Blue T-Shirt","reference_id":"TShirtBlueM","sku":"TShirtBlueM"}]}],"id":0,"measurements":{"depth_in":0.1,"length_in":0.1,"total_weight_oz":0.1,"width_in":0.1},"type":"Box or pallet"}],"measurements":{"depth_in":0.1,"length_in":0.1,"total_weight_oz":0.1,"width_in":0.1},"type":"Box or pallet"}],"products":[{"id":0,"inventory_items":[{"expiration_date":"2019-08-24T14:15:22+00:00","id":0,"is_dangerous_goods":true,"lot":"22222","name":"Medium Blue T-Shirt","quantity":0,"quantity_committed":0,"serial_numbers":["string"]}],"name":"Medium Blue T-Shirt","reference_id":"TShirtBlueM","sku":"TShirtBlueM"}],"recipient":{"address":{"address1":"100 Nowhere Blvd","address2":"Suite 100","city":"Gotham City","company_name":"Wayne Enterprises","country":"US","state":"NJ","zip_code":"07093"},"email":"john@example.com","full_name":"John Doe","name":"John Doe","phone_number":"555-555-5555"},"reference_id":"string","require_signature":true,"ship_option":"Standard","status":"None","status_details":[{"description":"string","exception_fulfillment_center_id":0,"extra_information":{"validation_messages":["string"]},"id":0,"inventory_id":0,"name":"string"}],"tracking":{"bol":"string","carrier":"USPS","carrier_service":"Priority","pro_number":"string","scac":"string","shipping_date":"2019-08-24T14:15:22+00:00","tracking_number":"860C8CDC8F0B4FC7AB69AC86C20539EC","tracking_url":"https://www.example.com/tracking?id=860C8CDC8F0B4FC7AB69AC86C20539EC"}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Order.OrderId.Shipment.ShipmentId.Cancel.Bad.Request.Object"},"examples":{"default":{"summary":"","description":"","value":{"property1":["string"],"property2":["string"]}}}}}},"401":{"description":"No access right at this time"},"403":{"description":"No access"},"404":{"description":"Not Found"},"422":{"description":"Client Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Order.OrderId.Shipment.ShipmentId.Cancel.Unprocessable.Entity.Object"},"examples":{"default":{"summary":"","description":"","value":{"property1":["string"],"property2":["string"]}}}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Order.OrderId.Shipment.ShipmentId.Cancel.Internal.Server.Error.Object"},"examples":{"default":{"summary":"","description":"","value":{"property1":["string"],"property2":["string"]}}}}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Orders"]}},"/2.0/order/estimate":{"post":{"summary":"Estimate Fulfillment Cost For Order","description":"This endpoint will provide, where possible, an estimate of pricing and fulfillment center assignment of a potential standard (direct to consumer) order. Keep in mind that there are ways for the merchant to change FC assignment or product configuration after order creation that could invalidate this estimate. Estimates cannot be returned for items that are unknown, out of stock, or too large for fulfillment using standard box sizes. Additional services such as high-pick fees, shipping insurance, auto-splitting or auto-adding items to orders, and signature required are not included in this estimate.","parameters":[{"name":"shipbob_channel_id","in":"header","description":"Channel Id for Operation","required":true,"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Order.Estimate.Shipbob.Channel.Id.Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.EstimateViewModel"},"examples":{"default":{"summary":"","description":"","value":{"estimates":[{"estimated_currency_code":"string","estimated_price":0.1,"fulfillment_center":{"id":0,"name":"Cicero (IL)"},"shipping_method":"string","total_weight_oz":0.1}]}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Order.Estimate.Bad.Request.Object"},"examples":{"default":{"summary":"","description":"","value":{"property1":["string"],"property2":["string"]}}}}}},"401":{"description":"No access right at this time"},"403":{"description":"No access"},"422":{"description":"Client Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Order.Estimate.Unprocessable.Entity.Object"},"examples":{"default":{"summary":"","description":"","value":{"property1":["string"],"property2":["string"]}}}}}}},"requestBody":{"description":"","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/Orders.EstimateFulfillmentRequestModel"},"examples":{"default":{"summary":"","description":"","value":{"address":{"address1":"100 Nowhere Blvd","address2":"Suite 100","city":"Gotham City","company_name":"Wayne Enterprises","country":"US","state":"NJ","zip_code":"07093"},"products":[{"id":0,"quantity":1,"reference_id":"TShirtBlueM"}],"shipping_methods":["string"]}}}},"application/json":{"schema":{"$ref":"#/components/schemas/Orders.EstimateFulfillmentRequestModel"},"examples":{"default":{"summary":"","description":"","value":{"address":{"address1":"100 Nowhere Blvd","address2":"Suite 100","city":"Gotham City","company_name":"Wayne Enterprises","country":"US","state":"NJ","zip_code":"07093"},"products":[{"id":0,"quantity":1,"reference_id":"TShirtBlueM"}],"shipping_methods":["string"]}}}},"text/json":{"schema":{"$ref":"#/components/schemas/Orders.EstimateFulfillmentRequestModel"},"examples":{"default":{"summary":"","description":"","value":{"address":{"address1":"100 Nowhere Blvd","address2":"Suite 100","city":"Gotham City","company_name":"Wayne Enterprises","country":"US","state":"NJ","zip_code":"07093"},"products":[{"id":0,"quantity":1,"reference_id":"TShirtBlueM"}],"shipping_methods":["string"]}}}},"application/*+json":{"schema":{"$ref":"#/components/schemas/Orders.EstimateFulfillmentRequestModel"},"examples":{"default":{"summary":"","description":"","value":{"address":{"address1":"100 Nowhere Blvd","address2":"Suite 100","city":"Gotham City","company_name":"Wayne Enterprises","country":"US","state":"NJ","zip_code":"07093"},"products":[{"id":0,"quantity":1,"reference_id":"TShirtBlueM"}],"shipping_methods":["string"]}}}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Orders"]}},"/2.0/shippingmethod":{"get":{"summary":"Get shipping methods","description":"Get all merchants shipping methods","parameters":[{"name":"Page","in":"query","description":"Page of orders to get","schema":{"$ref":"#/components/schemas/Orders.Get.Api.Shippingmethod.Page.Integer"},"examples":{"default":{"summary":"","description":"","value":2147483647}}},{"name":"Limit","in":"query","description":"Amount of records per page to request","schema":{"$ref":"#/components/schemas/Orders.Get.Api.Shippingmethod.Limit.Integer"},"examples":{"default":{"summary":"","description":"","value":1}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.ShipMethodDetailViewModelArray"},"examples":{"default":{"summary":"","description":"","value":[{"active":true,"default":true,"id":0,"name":"string","service_level":{"id":0,"name":"string"}}]}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Shippingmethod.Bad.Request.Object"},"examples":{"default":{"summary":"","description":"","value":{"property1":["string"],"property2":["string"]}}}}}},"401":{"description":"No access right at this time"},"403":{"description":"No access"},"422":{"description":"Client Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Shippingmethod.Unprocessable.Entity.Object"},"examples":{"default":{"summary":"","description":"","value":{"property1":["string"],"property2":["string"]}}}}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Orders"]}},"/2.0/order/{orderId}/shipment/{shipmentId}":{"get":{"summary":"Get one Shipment by Order Id and Shipment Id","parameters":[{"name":"orderId","in":"path","description":"The order id to get the shipment for","required":true,"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.OrderId.Integer"}},{"name":"shipmentId","in":"path","description":"The shipment id to get","required":true,"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.ShipmentId.Integer"}},{"name":"shipbob_channel_id","in":"header","description":"Channel Id for Operation","schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.Shipbob.Channel.Id.Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.OK.OneOf.ShipmentViewModel.InternalShipmentViewModel"},"examples":{"default":{"summary":"","description":"","value":{"actual_fulfillment_date":"2019-08-24T14:15:22+00:00","created_date":"2019-08-24T14:15:22+00:00","delivery_date":"2019-08-24T14:15:22+00:00","estimated_fulfillment_date":"2019-08-24T14:15:22+00:00","estimated_fulfillment_date_status":"AwaitingInventoryAllocation","gift_message":"string","id":0,"insurance_value":0,"invoice_amount":0,"invoice_currency_code":"string","is_tracking_uploaded":true,"last_tracking_update_at":"2019-08-24T14:15:22+00:00","last_update_at":"2019-08-24T14:15:22+00:00","location":{"id":0,"name":"Cicero (IL)"},"measurements":{"depth_in":0,"length_in":0,"total_weight_oz":0,"width_in":0},"order_id":0,"package_material_type":"Unknown","parent_cartons":[{"barcode":"string","cartons":[{"barcode":"string","carton_details":[{"products":[{"id":0,"inventory_items":[{"expiration_date":"2019-08-24T14:15:22+00:00","id":0,"is_dangerous_goods":true,"lot":"22222","name":"Medium Blue T-Shirt","quantity":0,"quantity_committed":0,"serial_numbers":["string"]}],"name":"Medium Blue T-Shirt","reference_id":"TShirtBlueM","sku":"TShirtBlueM"}]}],"id":0,"measurements":{"depth_in":0.1,"length_in":0.1,"total_weight_oz":0.1,"width_in":0.1},"type":"Box or pallet"}],"measurements":{"depth_in":0.1,"length_in":0.1,"total_weight_oz":0.1,"width_in":0.1},"type":"Box or pallet"}],"products":[{"id":0,"inventory_items":[{"expiration_date":"2019-08-24T14:15:22+00:00","id":0,"is_dangerous_goods":true,"lot":"22222","name":"Medium Blue T-Shirt","quantity":0,"quantity_committed":0,"serial_numbers":["string"]}],"name":"Medium Blue T-Shirt","reference_id":"TShirtBlueM","sku":"TShirtBlueM"}],"recipient":{"address":{"address1":"100 Nowhere Blvd","address2":"Suite 100","city":"Gotham City","company_name":"Wayne Enterprises","country":"US","state":"NJ","zip_code":"07093"},"email":"john@example.com","full_name":"John Doe","name":"John Doe","phone_number":"555-555-5555"},"reference_id":"string","require_signature":true,"ship_option":"Standard","status":"None","status_details":[{"description":"string","exception_fulfillment_center_id":0,"extra_information":{"validation_messages":["string"]},"id":0,"inventory_id":0,"name":"string"}],"tracking":{"bol":"string","carrier":"USPS","carrier_service":"Priority","pro_number":"string","scac":"string","shipping_date":"2019-08-24T14:15:22+00:00","tracking_number":"860C8CDC8F0B4FC7AB69AC86C20539EC","tracking_url":"https://www.example.com/tracking?id=860C8CDC8F0B4FC7AB69AC86C20539EC"}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.Bad.Request.Object"},"examples":{"default":{"summary":"","description":"","value":{"property1":["string"],"property2":["string"]}}}}}},"401":{"description":"No access right at this time"},"403":{"description":"No access"},"404":{"description":"Not Found"}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Orders"]}},"/2.0/order":{"post":{"summary":"Create Order","parameters":[{"name":"shipbob_channel_id","in":"header","description":"Channel Id for Operation","required":true,"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Order.Shipbob.Channel.Id.Integer"}}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.OrderViewModel"},"examples":{"default":{"summary":"","description":"","value":{"channel":{"id":0,"name":"ShipBobs-Shopify-Store"},"created_date":"2019-08-24T14:15:22+00:00","financials":{"total_price":0.1},"gift_message":"string","id":0,"order_number":"string","products":[{"external_line_id":0,"gtin":"string","id":0,"quantity":0,"quantity_unit_of_measure_code":"string","reference_id":"TShirtBlueM","sku":"TShirtBlueM","unit_price":0.1,"upc":"string"}],"purchase_date":"2019-08-24T14:15:22+00:00","recipient":{"address":{"address1":"100 Nowhere Blvd","address2":"Suite 100","city":"Gotham City","company_name":"Wayne Enterprises","country":"US","state":"NJ","zip_code":"07093"},"email":"john@example.com","name":"John Doe","phone_number":"555-555-5555"},"reference_id":"string","retailer_program_data":{"addresses":[{"address1":"100 Nowhere Blvd","address2":"Suite 100","city":"Gotham City","company_name":"Wayne Enterprises","country":"US","state":"NJ","type":"MarkFor","zip_code":"07093"}],"customer_ticket_number":"string","delivery_date":"2019-08-24T14:15:22+00:00","department":"string","doNotShipBeforeDate":"2019-08-24T14:15:22+00:00","mark_for_store":"string","purchase_order_number":"string","retailer_program_type":"string","shipByDate":"2019-08-24T14:15:22+00:00"},"shipments":[{"actual_fulfillment_date":"2019-08-24T14:15:22+00:00","created_date":"2019-08-24T14:15:22+00:00","delivery_date":"2019-08-24T14:15:22+00:00","estimated_fulfillment_date":"2019-08-24T14:15:22+00:00","estimated_fulfillment_date_status":"AwaitingInventoryAllocation","gift_message":"string","id":0,"insurance_value":0,"invoice_amount":0,"invoice_currency_code":"string","is_tracking_uploaded":true,"last_tracking_update_at":"2019-08-24T14:15:22+00:00","last_update_at":"2019-08-24T14:15:22+00:00","location":{"id":0,"name":"Cicero (IL)"},"measurements":{"depth_in":0,"length_in":0,"total_weight_oz":0,"width_in":0},"order_id":0,"package_material_type":"Unknown","parent_cartons":[{"barcode":"string","cartons":[{"barcode":"string","carton_details":[{"products":[{"id":0,"inventory_items":[{"expiration_date":"2019-08-24T14:15:22+00:00","id":0,"is_dangerous_goods":true,"lot":"22222","name":"Medium Blue T-Shirt","quantity":0,"quantity_committed":0,"serial_numbers":["string"]}],"name":"Medium Blue T-Shirt","reference_id":"TShirtBlueM","sku":"TShirtBlueM"}]}],"id":0,"measurements":{"depth_in":0.1,"length_in":0.1,"total_weight_oz":0.1,"width_in":0.1},"type":"Box or pallet"}],"measurements":{"depth_in":0.1,"length_in":0.1,"total_weight_oz":0.1,"width_in":0.1},"type":"Box or pallet"}],"products":[{"id":0,"inventory_items":[{"expiration_date":"2019-08-24T14:15:22+00:00","id":0,"is_dangerous_goods":true,"lot":"22222","name":"Medium Blue T-Shirt","quantity":0,"quantity_committed":0,"serial_numbers":["string"]}],"name":"Medium Blue T-Shirt","reference_id":"TShirtBlueM","sku":"TShirtBlueM"}],"recipient":{"address":{"address1":"100 Nowhere Blvd","address2":"Suite 100","city":"Gotham City","company_name":"Wayne Enterprises","country":"US","state":"NJ","zip_code":"07093"},"email":"john@example.com","full_name":"John Doe","name":"John Doe","phone_number":"555-555-5555"},"reference_id":"string","require_signature":true,"ship_option":"Standard","status":"None","status_details":[{"description":"string","exception_fulfillment_center_id":0,"extra_information":{"validation_messages":["string"]},"id":0,"inventory_id":0,"name":"string"}],"tracking":{"bol":"string","carrier":"USPS","carrier_service":"Priority","pro_number":"string","scac":"string","shipping_date":"2019-08-24T14:15:22+00:00","tracking_number":"860C8CDC8F0B4FC7AB69AC86C20539EC","tracking_url":"https://www.example.com/tracking?id=860C8CDC8F0B4FC7AB69AC86C20539EC"}}],"shipping_method":"Free 2-day Shipping","shipping_terms":{"carrier_type":"Parcel","payment_term":"Collect"},"status":"Processing","tags":[{"name":"Handling instructions","value":"Fragile"}],"type":"DTC"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Order.Bad.Request.Object"},"examples":{"default":{"summary":"","description":"","value":{"property1":["string"],"property2":["string"]}}}}}},"401":{"description":"No access right at this time"},"403":{"description":"No access"},"422":{"description":"Client Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Order.Unprocessable.Entity.Object"},"examples":{"default":{"summary":"","description":"","value":{"property1":["string"],"property2":["string"]}}}}}}},"requestBody":{"description":"","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/Orders.CreateOrderModel"},"examples":{"default":{"summary":"","description":"","value":{"financials":{"total_price":0.1},"gift_message":"string","location_id":0,"order_number":"string","products":[{"external_line_id":0,"id":0,"quantity":1,"quantity_unit_of_measure_code":"string"}],"purchase_date":"2019-08-24T14:15:22+00:00","recipient":{"address":{"address1":"100 Nowhere Blvd","address2":"Suite 100","city":"Gotham City","company_name":"Wayne Enterprises","country":"US","state":"NJ","zip_code":"07093"},"email":"john@example.com","name":"John Doe","phone_number":"555-555-5555"},"reference_id":"string","retailer_program_data":{"addresses":[{"address1":"100 Nowhere Blvd","address2":"Suite 100","city":"Gotham City","company_name":"Wayne Enterprises","country":"US","state":"NJ","type":"MarkFor","zip_code":"07093"}],"customer_ticket_number":"string","delivery_date":"2019-08-24T14:15:22+00:00","department":"string","doNotShipBeforeDate":"2019-08-24T14:15:22+00:00","mark_for_store":"string","purchase_order_number":"string","retailer_program_type":"string","shipByDate":"2019-08-24T14:15:22+00:00"},"shipping_method":"Free 2-day Shipping","shipping_terms":{"carrier_type":"Parcel","payment_term":"Collect"},"tags":[{"name":"Handling instructions","value":"Fragile"}],"type":"DTC"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/Orders.CreateOrderModel"},"examples":{"default":{"summary":"","description":"","value":{"financials":{"total_price":0.1},"gift_message":"string","location_id":0,"order_number":"string","products":[{"external_line_id":0,"id":0,"quantity":1,"quantity_unit_of_measure_code":"string"}],"purchase_date":"2019-08-24T14:15:22+00:00","recipient":{"address":{"address1":"100 Nowhere Blvd","address2":"Suite 100","city":"Gotham City","company_name":"Wayne Enterprises","country":"US","state":"NJ","zip_code":"07093"},"email":"john@example.com","name":"John Doe","phone_number":"555-555-5555"},"reference_id":"string","retailer_program_data":{"addresses":[{"address1":"100 Nowhere Blvd","address2":"Suite 100","city":"Gotham City","company_name":"Wayne Enterprises","country":"US","state":"NJ","type":"MarkFor","zip_code":"07093"}],"customer_ticket_number":"string","delivery_date":"2019-08-24T14:15:22+00:00","department":"string","doNotShipBeforeDate":"2019-08-24T14:15:22+00:00","mark_for_store":"string","purchase_order_number":"string","retailer_program_type":"string","shipByDate":"2019-08-24T14:15:22+00:00"},"shipping_method":"Free 2-day Shipping","shipping_terms":{"carrier_type":"Parcel","payment_term":"Collect"},"tags":[{"name":"Handling instructions","value":"Fragile"}],"type":"DTC"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/Orders.CreateOrderModel"},"examples":{"default":{"summary":"","description":"","value":{"financials":{"total_price":0.1},"gift_message":"string","location_id":0,"order_number":"string","products":[{"external_line_id":0,"id":0,"quantity":1,"quantity_unit_of_measure_code":"string"}],"purchase_date":"2019-08-24T14:15:22+00:00","recipient":{"address":{"address1":"100 Nowhere Blvd","address2":"Suite 100","city":"Gotham City","company_name":"Wayne Enterprises","country":"US","state":"NJ","zip_code":"07093"},"email":"john@example.com","name":"John Doe","phone_number":"555-555-5555"},"reference_id":"string","retailer_program_data":{"addresses":[{"address1":"100 Nowhere Blvd","address2":"Suite 100","city":"Gotham City","company_name":"Wayne Enterprises","country":"US","state":"NJ","type":"MarkFor","zip_code":"07093"}],"customer_ticket_number":"string","delivery_date":"2019-08-24T14:15:22+00:00","department":"string","doNotShipBeforeDate":"2019-08-24T14:15:22+00:00","mark_for_store":"string","purchase_order_number":"string","retailer_program_type":"string","shipByDate":"2019-08-24T14:15:22+00:00"},"shipping_method":"Free 2-day Shipping","shipping_terms":{"carrier_type":"Parcel","payment_term":"Collect"},"tags":[{"name":"Handling instructions","value":"Fragile"}],"type":"DTC"}}}},"application/*+json":{"schema":{"$ref":"#/components/schemas/Orders.CreateOrderModel"},"examples":{"default":{"summary":"","description":"","value":{"financials":{"total_price":0.1},"gift_message":"string","location_id":0,"order_number":"string","products":[{"external_line_id":0,"id":0,"quantity":1,"quantity_unit_of_measure_code":"string"}],"purchase_date":"2019-08-24T14:15:22+00:00","recipient":{"address":{"address1":"100 Nowhere Blvd","address2":"Suite 100","city":"Gotham City","company_name":"Wayne Enterprises","country":"US","state":"NJ","zip_code":"07093"},"email":"john@example.com","name":"John Doe","phone_number":"555-555-5555"},"reference_id":"string","retailer_program_data":{"addresses":[{"address1":"100 Nowhere Blvd","address2":"Suite 100","city":"Gotham City","company_name":"Wayne Enterprises","country":"US","state":"NJ","type":"MarkFor","zip_code":"07093"}],"customer_ticket_number":"string","delivery_date":"2019-08-24T14:15:22+00:00","department":"string","doNotShipBeforeDate":"2019-08-24T14:15:22+00:00","mark_for_store":"string","purchase_order_number":"string","retailer_program_type":"string","shipByDate":"2019-08-24T14:15:22+00:00"},"shipping_method":"Free 2-day Shipping","shipping_terms":{"carrier_type":"Parcel","payment_term":"Collect"},"tags":[{"name":"Handling instructions","value":"Fragile"}],"type":"DTC"}}}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Orders"]},"get":{"summary":"Get Orders","description":"All parameters are AND filters","parameters":[{"name":"Page","in":"query","description":"Page of orders to get","schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.Page.Integer"},"examples":{"default":{"summary":"","description":"","value":1}}},{"name":"Limit","in":"query","description":"Amount of orders per page to request","schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.Limit.Integer"},"examples":{"default":{"summary":"","description":"","value":1}}},{"name":"IDs","in":"query","description":"order ids to filter by, comma separated <br /><strong>Example:</strong> ?IDs=1,2","schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.IDs.IntegerArray"},"examples":{"default":{"summary":"","description":"","value":[0]}}},{"name":"ReferenceIds","in":"query","description":"Reference ids to filter by, comma separated <br /><strong>Example:</strong> ?ReferenceIds=Ref1,Ref2","schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.ReferenceIds.StringArray"},"examples":{"default":{"summary":"","description":"","value":["string"]}}},{"name":"StartDate","in":"query","description":"Start date to filter orders inserted later than","schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.StartDate.String"},"examples":{"default":{"summary":"","description":"","value":"2019-08-24T14:15:22+00:00"}}},{"name":"EndDate","in":"query","description":"End date to filter orders inserted earlier than","schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.EndDate.String"},"examples":{"default":{"summary":"","description":"","value":"2019-08-24T14:15:22+00:00"}}},{"name":"SortOrder","in":"query","description":"Order to sort results in","schema":{"$ref":"#/components/schemas/Orders.SortOrder"},"examples":{"default":{"summary":"","description":"","value":"Newest"}}},{"name":"HasTracking","in":"query","description":"Has any portion of this order been assigned a tracking number","schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.HasTracking.Boolean"},"examples":{"default":{"summary":"","description":"","value":"True"}}},{"name":"LastUpdateStartDate","in":"query","description":"Start date to filter orders updated later than","schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.LastUpdateStartDate.String"},"examples":{"default":{"summary":"","description":"","value":"2019-08-24T14:15:22+00:00"}}},{"name":"LastUpdateEndDate","in":"query","description":"End date to filter orders updated later than","schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.LastUpdateEndDate.String"},"examples":{"default":{"summary":"","description":"","value":"2019-08-24T14:15:22+00:00"}}},{"name":"IsTrackingUploaded","in":"query","description":"Filter orders that their tracking information was fully uploaded","schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.IsTrackingUploaded.Boolean"},"examples":{"default":{"summary":"","description":"","value":"True"}}},{"name":"LastTrackingUpdateStartDate","in":"query","description":"Start date to filter orders with tracking updates later than the supplied date. Will only return orders that have tracking information","schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.LastTrackingUpdateStartDate.String"},"examples":{"default":{"summary":"","description":"","value":"2019-08-24T14:15:22+00:00"}}},{"name":"LastTrackingUpdateEndDate","in":"query","description":"End date to filter orders updated later than the supplied date. Will only return orders that have tracking information","schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.LastTrackingUpdateEndDate.String"},"examples":{"default":{"summary":"","description":"","value":"2019-08-24T14:15:22+00:00"}}},{"name":"shipbob_channel_id","in":"header","description":"Channel Id for Operation","schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.Shipbob.Channel.Id.Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.OrderViewModelArray"},"examples":{"default":{"summary":"","description":"","value":[{"channel":{"id":0,"name":"ShipBobs-Shopify-Store"},"created_date":"2019-08-24T14:15:22+00:00","financials":{"total_price":0.1},"gift_message":"string","id":0,"order_number":"string","products":[{"external_line_id":0,"gtin":"string","id":0,"quantity":0,"quantity_unit_of_measure_code":"string","reference_id":"TShirtBlueM","sku":"TShirtBlueM","unit_price":0.1,"upc":"string"}],"purchase_date":"2019-08-24T14:15:22+00:00","recipient":{"address":{"address1":"100 Nowhere Blvd","address2":"Suite 100","city":"Gotham City","company_name":"Wayne Enterprises","country":"US","state":"NJ","zip_code":"07093"},"email":"john@example.com","name":"John Doe","phone_number":"555-555-5555"},"reference_id":"string","retailer_program_data":{"addresses":[{"address1":"100 Nowhere Blvd","address2":"Suite 100","city":"Gotham City","company_name":"Wayne Enterprises","country":"US","state":"NJ","type":"MarkFor","zip_code":"07093"}],"customer_ticket_number":"string","delivery_date":"2019-08-24T14:15:22+00:00","department":"string","doNotShipBeforeDate":"2019-08-24T14:15:22+00:00","mark_for_store":"string","purchase_order_number":"string","retailer_program_type":"string","shipByDate":"2019-08-24T14:15:22+00:00"},"shipments":[{"actual_fulfillment_date":"2019-08-24T14:15:22+00:00","created_date":"2019-08-24T14:15:22+00:00","delivery_date":"2019-08-24T14:15:22+00:00","estimated_fulfillment_date":"2019-08-24T14:15:22+00:00","estimated_fulfillment_date_status":"AwaitingInventoryAllocation","gift_message":"string","id":0,"insurance_value":0,"invoice_amount":0,"invoice_currency_code":"string","is_tracking_uploaded":true,"last_tracking_update_at":"2019-08-24T14:15:22+00:00","last_update_at":"2019-08-24T14:15:22+00:00","location":{"id":0,"name":"Cicero (IL)"},"measurements":{"depth_in":0,"length_in":0,"total_weight_oz":0,"width_in":0},"order_id":0,"package_material_type":"Unknown","parent_cartons":[{"barcode":"string","cartons":[{"barcode":"string","carton_details":[{"products":[{"id":0,"inventory_items":[{"expiration_date":"2019-08-24T14:15:22+00:00","id":0,"is_dangerous_goods":true,"lot":"22222","name":"Medium Blue T-Shirt","quantity":0,"quantity_committed":0,"serial_numbers":[null]}],"name":"Medium Blue T-Shirt","reference_id":"TShirtBlueM","sku":"TShirtBlueM"}]}],"id":0,"measurements":{"depth_in":0.1,"length_in":0.1,"total_weight_oz":0.1,"width_in":0.1},"type":"Box or pallet"}],"measurements":{"depth_in":0.1,"length_in":0.1,"total_weight_oz":0.1,"width_in":0.1},"type":"Box or pallet"}],"products":[{"id":0,"inventory_items":[{"expiration_date":"2019-08-24T14:15:22+00:00","id":0,"is_dangerous_goods":true,"lot":"22222","name":"Medium Blue T-Shirt","quantity":0,"quantity_committed":0,"serial_numbers":["string"]}],"name":"Medium Blue T-Shirt","reference_id":"TShirtBlueM","sku":"TShirtBlueM"}],"recipient":{"address":{"address1":"100 Nowhere Blvd","address2":"Suite 100","city":"Gotham City","company_name":"Wayne Enterprises","country":"US","state":"NJ","zip_code":"07093"},"email":"john@example.com","full_name":"John Doe","name":"John Doe","phone_number":"555-555-5555"},"reference_id":"string","require_signature":true,"ship_option":"Standard","status":"None","status_details":[{"description":"string","exception_fulfillment_center_id":0,"extra_information":{"validation_messages":["string"]},"id":0,"inventory_id":0,"name":"string"}],"tracking":{"bol":"string","carrier":"USPS","carrier_service":"Priority","pro_number":"string","scac":"string","shipping_date":"2019-08-24T14:15:22+00:00","tracking_number":"860C8CDC8F0B4FC7AB69AC86C20539EC","tracking_url":"https://www.example.com/tracking?id=860C8CDC8F0B4FC7AB69AC86C20539EC"}}],"shipping_method":"Free 2-day Shipping","shipping_terms":{"carrier_type":"Parcel","payment_term":"Collect"},"status":"Processing","tags":[{"name":"Handling instructions","value":"Fragile"}],"type":"DTC"}]}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.Bad.Request.Object"},"examples":{"default":{"summary":"","description":"","value":{"property1":["string"],"property2":["string"]}}}}}},"401":{"description":"No access right at this time"},"403":{"description":"No access"}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Orders"]}},"/2.0/order/{orderId}/cancel":{"post":{"summary":"Cancel single Order by Order ID","parameters":[{"name":"orderId","in":"path","description":"The order ID to cancel","required":true,"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Order.OrderId.Cancel.OrderId.Integer"}},{"name":"shipbob_channel_id","in":"header","description":"Channel ID for Operation","required":true,"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Order.OrderId.Cancel.Shipbob.Channel.Id.Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.CanceledOrderViewModel"},"examples":{"default":{"summary":"","description":"","value":{"canceled_shipment_results":[{"action":"Cancel","is_success":true,"reason":"string","shipment_id":0}],"order":{"channel":{"id":0,"name":"ShipBobs-Shopify-Store"},"created_date":"2019-08-24T14:15:22+00:00","financials":{"total_price":0.1},"gift_message":"string","id":0,"order_number":"string","products":[{"external_line_id":0,"gtin":"string","id":0,"quantity":0,"quantity_unit_of_measure_code":"string","reference_id":"TShirtBlueM","sku":"TShirtBlueM","unit_price":0.1,"upc":"string"}],"purchase_date":"2019-08-24T14:15:22+00:00","recipient":{"address":{"address1":"100 Nowhere Blvd","address2":"Suite 100","city":"Gotham City","company_name":"Wayne Enterprises","country":"US","state":"NJ","zip_code":"07093"},"email":"john@example.com","name":"John Doe","phone_number":"555-555-5555"},"reference_id":"string","retailer_program_data":{"addresses":[{"address1":"100 Nowhere Blvd","address2":"Suite 100","city":"Gotham City","company_name":"Wayne Enterprises","country":"US","state":"NJ","type":"MarkFor","zip_code":"07093"}],"customer_ticket_number":"string","delivery_date":"2019-08-24T14:15:22+00:00","department":"string","doNotShipBeforeDate":"2019-08-24T14:15:22+00:00","mark_for_store":"string","purchase_order_number":"string","retailer_program_type":"string","shipByDate":"2019-08-24T14:15:22+00:00"},"shipments":[{"actual_fulfillment_date":"2019-08-24T14:15:22+00:00","created_date":"2019-08-24T14:15:22+00:00","delivery_date":"2019-08-24T14:15:22+00:00","estimated_fulfillment_date":"2019-08-24T14:15:22+00:00","estimated_fulfillment_date_status":"AwaitingInventoryAllocation","gift_message":"string","id":0,"insurance_value":0,"invoice_amount":0,"invoice_currency_code":"string","is_tracking_uploaded":true,"last_tracking_update_at":"2019-08-24T14:15:22+00:00","last_update_at":"2019-08-24T14:15:22+00:00","location":{"id":0,"name":"Cicero (IL)"},"measurements":{"depth_in":0,"length_in":0,"total_weight_oz":0,"width_in":0},"order_id":0,"package_material_type":"Unknown","parent_cartons":[{"barcode":"string","cartons":[{"barcode":"string","carton_details":[{"products":[{"id":0,"inventory_items":[{"expiration_date":"2019-08-24T14:15:22+00:00","id":0,"is_dangerous_goods":true,"lot":"22222","name":"Medium Blue T-Shirt","quantity":0,"quantity_committed":0,"serial_numbers":[null]}],"name":"Medium Blue T-Shirt","reference_id":"TShirtBlueM","sku":"TShirtBlueM"}]}],"id":0,"measurements":{"depth_in":0.1,"length_in":0.1,"total_weight_oz":0.1,"width_in":0.1},"type":"Box or pallet"}],"measurements":{"depth_in":0.1,"length_in":0.1,"total_weight_oz":0.1,"width_in":0.1},"type":"Box or pallet"}],"products":[{"id":0,"inventory_items":[{"expiration_date":"2019-08-24T14:15:22+00:00","id":0,"is_dangerous_goods":true,"lot":"22222","name":"Medium Blue T-Shirt","quantity":0,"quantity_committed":0,"serial_numbers":["string"]}],"name":"Medium Blue T-Shirt","reference_id":"TShirtBlueM","sku":"TShirtBlueM"}],"recipient":{"address":{"address1":"100 Nowhere Blvd","address2":"Suite 100","city":"Gotham City","company_name":"Wayne Enterprises","country":"US","state":"NJ","zip_code":"07093"},"email":"john@example.com","full_name":"John Doe","name":"John Doe","phone_number":"555-555-5555"},"reference_id":"string","require_signature":true,"ship_option":"Standard","status":"None","status_details":[{"description":"string","exception_fulfillment_center_id":0,"extra_information":{"validation_messages":["string"]},"id":0,"inventory_id":0,"name":"string"}],"tracking":{"bol":"string","carrier":"USPS","carrier_service":"Priority","pro_number":"string","scac":"string","shipping_date":"2019-08-24T14:15:22+00:00","tracking_number":"860C8CDC8F0B4FC7AB69AC86C20539EC","tracking_url":"https://www.example.com/tracking?id=860C8CDC8F0B4FC7AB69AC86C20539EC"}}],"shipping_method":"Free 2-day Shipping","shipping_terms":{"carrier_type":"Parcel","payment_term":"Collect"},"status":"Processing","tags":[{"name":"Handling instructions","value":"Fragile"}],"type":"DTC"},"order_id":0,"status":"Success"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Order.OrderId.Cancel.Bad.Request.Object"},"examples":{"default":{"summary":"","description":"","value":{"property1":["string"],"property2":["string"]}}}}}},"401":{"description":"No access right at this time"},"403":{"description":"No access"},"404":{"description":"Not Found"},"422":{"description":"Client Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Order.OrderId.Cancel.Unprocessable.Entity.Object"},"examples":{"default":{"summary":"","description":"","value":{"property1":["string"],"property2":["string"]}}}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Order.OrderId.Cancel.Internal.Server.Error.Object"},"examples":{"default":{"summary":"","description":"","value":{"property1":["string"],"property2":["string"]}}}}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Orders"]}},"/2.0/order/{orderId}/shipment":{"get":{"summary":"Get all Shipments for Order","parameters":[{"name":"orderId","in":"path","description":"The order id to get shipments for","required":true,"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.OrderId.Shipment.OrderId.Integer"}},{"name":"shipbob_channel_id","in":"header","description":"Channel Id for Operation","schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.OrderId.Shipment.Shipbob.Channel.Id.Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.OrderId.Shipment.OK.OneOfArray"},"examples":{"default":{"summary":"","description":"","value":[{"actual_fulfillment_date":"2019-08-24T14:15:22+00:00","created_date":"2019-08-24T14:15:22+00:00","delivery_date":"2019-08-24T14:15:22+00:00","estimated_fulfillment_date":"2019-08-24T14:15:22+00:00","estimated_fulfillment_date_status":"AwaitingInventoryAllocation","gift_message":"string","id":0,"insurance_value":0,"invoice_amount":0,"invoice_currency_code":"string","is_tracking_uploaded":true,"last_tracking_update_at":"2019-08-24T14:15:22+00:00","last_update_at":"2019-08-24T14:15:22+00:00","location":{"id":0,"name":"Cicero (IL)"},"measurements":{"depth_in":0,"length_in":0,"total_weight_oz":0,"width_in":0},"order_id":0,"package_material_type":"Unknown","parent_cartons":[{"barcode":"string","cartons":[{"barcode":"string","carton_details":[{"products":[{"id":0,"inventory_items":[{"expiration_date":"2019-08-24T14:15:22+00:00","id":0,"is_dangerous_goods":true,"lot":"22222","name":"Medium Blue T-Shirt","quantity":0,"quantity_committed":0,"serial_numbers":["string"]}],"name":"Medium Blue T-Shirt","reference_id":"TShirtBlueM","sku":"TShirtBlueM"}]}],"id":0,"measurements":{"depth_in":0.1,"length_in":0.1,"total_weight_oz":0.1,"width_in":0.1},"type":"Box or pallet"}],"measurements":{"depth_in":0.1,"length_in":0.1,"total_weight_oz":0.1,"width_in":0.1},"type":"Box or pallet"}],"products":[{"id":0,"inventory_items":[{"expiration_date":"2019-08-24T14:15:22+00:00","id":0,"is_dangerous_goods":true,"lot":"22222","name":"Medium Blue T-Shirt","quantity":0,"quantity_committed":0,"serial_numbers":["string"]}],"name":"Medium Blue T-Shirt","reference_id":"TShirtBlueM","sku":"TShirtBlueM"}],"recipient":{"address":{"address1":"100 Nowhere Blvd","address2":"Suite 100","city":"Gotham City","company_name":"Wayne Enterprises","country":"US","state":"NJ","zip_code":"07093"},"email":"john@example.com","full_name":"John Doe","name":"John Doe","phone_number":"555-555-5555"},"reference_id":"string","require_signature":true,"ship_option":"Standard","status":"None","status_details":[{"description":"string","exception_fulfillment_center_id":0,"extra_information":{"validation_messages":["string"]},"id":0,"inventory_id":0,"name":"string"}],"tracking":{"bol":"string","carrier":"USPS","carrier_service":"Priority","pro_number":"string","scac":"string","shipping_date":"2019-08-24T14:15:22+00:00","tracking_number":"860C8CDC8F0B4FC7AB69AC86C20539EC","tracking_url":"https://www.example.com/tracking?id=860C8CDC8F0B4FC7AB69AC86C20539EC"}}]}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.OrderId.Shipment.Bad.Request.Object"},"examples":{"default":{"summary":"","description":"","value":{"property1":["string"],"property2":["string"]}}}}}},"401":{"description":"No access right at this time"},"403":{"description":"No access"},"404":{"description":"Not Found"}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Orders"]}},"/2.0/shipment/{shipmentId}/cancel":{"post":{"summary":"Cancel one Shipment by Shipment Id","parameters":[{"name":"shipmentId","in":"path","description":"The shipment id to get","required":true,"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Shipment.ShipmentId.Cancel.ShipmentId.Integer"}},{"name":"shipbob_channel_id","in":"header","description":"Channel Id for Operation","schema":{"$ref":"#/components/schemas/Orders.Post.Api.Shipment.ShipmentId.Cancel.Shipbob.Channel.Id.Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Shipment.ShipmentId.Cancel.OK.OneOf.ShipmentViewModel.InternalShipmentViewModel"},"examples":{"default":{"summary":"","description":"","value":{"actual_fulfillment_date":"2019-08-24T14:15:22+00:00","created_date":"2019-08-24T14:15:22+00:00","delivery_date":"2019-08-24T14:15:22+00:00","estimated_fulfillment_date":"2019-08-24T14:15:22+00:00","estimated_fulfillment_date_status":"AwaitingInventoryAllocation","gift_message":"string","id":0,"insurance_value":0,"invoice_amount":0,"invoice_currency_code":"string","is_tracking_uploaded":true,"last_tracking_update_at":"2019-08-24T14:15:22+00:00","last_update_at":"2019-08-24T14:15:22+00:00","location":{"id":0,"name":"Cicero (IL)"},"measurements":{"depth_in":0,"length_in":0,"total_weight_oz":0,"width_in":0},"order_id":0,"package_material_type":"Unknown","parent_cartons":[{"barcode":"string","cartons":[{"barcode":"string","carton_details":[{"products":[{"id":0,"inventory_items":[{"expiration_date":"2019-08-24T14:15:22+00:00","id":0,"is_dangerous_goods":true,"lot":"22222","name":"Medium Blue T-Shirt","quantity":0,"quantity_committed":0,"serial_numbers":["string"]}],"name":"Medium Blue T-Shirt","reference_id":"TShirtBlueM","sku":"TShirtBlueM"}]}],"id":0,"measurements":{"depth_in":0.1,"length_in":0.1,"total_weight_oz":0.1,"width_in":0.1},"type":"Box or pallet"}],"measurements":{"depth_in":0.1,"length_in":0.1,"total_weight_oz":0.1,"width_in":0.1},"type":"Box or pallet"}],"products":[{"id":0,"inventory_items":[{"expiration_date":"2019-08-24T14:15:22+00:00","id":0,"is_dangerous_goods":true,"lot":"22222","name":"Medium Blue T-Shirt","quantity":0,"quantity_committed":0,"serial_numbers":["string"]}],"name":"Medium Blue T-Shirt","reference_id":"TShirtBlueM","sku":"TShirtBlueM"}],"recipient":{"address":{"address1":"100 Nowhere Blvd","address2":"Suite 100","city":"Gotham City","company_name":"Wayne Enterprises","country":"US","state":"NJ","zip_code":"07093"},"email":"john@example.com","full_name":"John Doe","name":"John Doe","phone_number":"555-555-5555"},"reference_id":"string","require_signature":true,"ship_option":"Standard","status":"None","status_details":[{"description":"string","exception_fulfillment_center_id":0,"extra_information":{"validation_messages":["string"]},"id":0,"inventory_id":0,"name":"string"}],"tracking":{"bol":"string","carrier":"USPS","carrier_service":"Priority","pro_number":"string","scac":"string","shipping_date":"2019-08-24T14:15:22+00:00","tracking_number":"860C8CDC8F0B4FC7AB69AC86C20539EC","tracking_url":"https://www.example.com/tracking?id=860C8CDC8F0B4FC7AB69AC86C20539EC"}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Shipment.ShipmentId.Cancel.Bad.Request.Object"},"examples":{"default":{"summary":"","description":"","value":{"property1":["string"],"property2":["string"]}}}}}},"401":{"description":"No access right at this time"},"403":{"description":"No access"},"404":{"description":"Not Found"},"422":{"description":"Client Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Shipment.ShipmentId.Cancel.Unprocessable.Entity.Object"},"examples":{"default":{"summary":"","description":"","value":{"property1":["string"],"property2":["string"]}}}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Shipment.ShipmentId.Cancel.Internal.Server.Error.Object"},"examples":{"default":{"summary":"","description":"","value":{"property1":["string"],"property2":["string"]}}}}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Orders"]}},"/2.0/order/{orderId}/storeOrderJson":{"post":{"summary":"Save the Store Order Json","parameters":[{"name":"orderId","in":"path","description":"The order ID to Store","required":true,"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Order.OrderId.StoreOrderJson.OrderId.Integer"}}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Order.OrderId.StoreOrderJson.Created.String"},"examples":{"default":{"summary":"","description":"","value":"string"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Order.OrderId.StoreOrderJson.Bad.Request.Object"},"examples":{"default":{"summary":"","description":"","value":{"property1":["string"],"property2":["string"]}}}}}},"401":{"description":"No access right at this time"},"403":{"description":"No access"},"404":{"description":"Not Found"},"422":{"description":"Client Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Order.OrderId.StoreOrderJson.Unprocessable.Entity.Object"},"examples":{"default":{"summary":"","description":"","value":{"property1":["string"],"property2":["string"]}}}}}}},"requestBody":{"description":"The JSON that represent the order on the Third Party Source","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/Orders.AddStoreOrderJsonModel"},"examples":{"default":{"summary":"","description":"","value":{"order_json":"string"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/Orders.AddStoreOrderJsonModel"},"examples":{"default":{"summary":"","description":"","value":{"order_json":"string"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/Orders.AddStoreOrderJsonModel"},"examples":{"default":{"summary":"","description":"","value":{"order_json":"string"}}}},"application/*+json":{"schema":{"$ref":"#/components/schemas/Orders.AddStoreOrderJsonModel"},"examples":{"default":{"summary":"","description":"","value":{"order_json":"string"}}}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Orders"]},"get":{"summary":"Get Order Store Json","parameters":[{"name":"orderId","in":"path","description":"The order ID to Get the JSON Stored","required":true,"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.OrderId.StoreOrderJson.OrderId.Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.OrderId.StoreOrderJson.OK.String"},"examples":{"default":{"summary":"","description":"","value":"string"}}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.OrderId.StoreOrderJson.Bad.Request.Object"},"examples":{"default":{"summary":"","description":"","value":{"property1":["string"],"property2":["string"]}}}}}},"401":{"description":"No access right at this time"},"403":{"description":"No access"},"404":{"description":"Not Found"},"422":{"description":"Client Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.OrderId.StoreOrderJson.Unprocessable.Entity.Object"},"examples":{"default":{"summary":"","description":"","value":{"property1":["string"],"property2":["string"]}}}}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Orders"]}},"/2.0/shipment/{shipmentId}":{"get":{"summary":"Get one Shipment by Shipment Id","parameters":[{"name":"shipmentId","in":"path","description":"The shipment id to get","required":true,"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Shipment.ShipmentId.ShipmentId.Integer"}},{"name":"shipbob_channel_id","in":"header","description":"Channel Id for Operation","schema":{"$ref":"#/components/schemas/Orders.Get.Api.Shipment.ShipmentId.Shipbob.Channel.Id.Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Shipment.ShipmentId.OK.OneOf.ShipmentViewModel.InternalShipmentViewModel"},"examples":{"default":{"summary":"","description":"","value":{"actual_fulfillment_date":"2019-08-24T14:15:22+00:00","created_date":"2019-08-24T14:15:22+00:00","delivery_date":"2019-08-24T14:15:22+00:00","estimated_fulfillment_date":"2019-08-24T14:15:22+00:00","estimated_fulfillment_date_status":"AwaitingInventoryAllocation","gift_message":"string","id":0,"insurance_value":0,"invoice_amount":0,"invoice_currency_code":"string","is_tracking_uploaded":true,"last_tracking_update_at":"2019-08-24T14:15:22+00:00","last_update_at":"2019-08-24T14:15:22+00:00","location":{"id":0,"name":"Cicero (IL)"},"measurements":{"depth_in":0,"length_in":0,"total_weight_oz":0,"width_in":0},"order_id":0,"package_material_type":"Unknown","parent_cartons":[{"barcode":"string","cartons":[{"barcode":"string","carton_details":[{"products":[{"id":0,"inventory_items":[{"expiration_date":"2019-08-24T14:15:22+00:00","id":0,"is_dangerous_goods":true,"lot":"22222","name":"Medium Blue T-Shirt","quantity":0,"quantity_committed":0,"serial_numbers":["string"]}],"name":"Medium Blue T-Shirt","reference_id":"TShirtBlueM","sku":"TShirtBlueM"}]}],"id":0,"measurements":{"depth_in":0.1,"length_in":0.1,"total_weight_oz":0.1,"width_in":0.1},"type":"Box or pallet"}],"measurements":{"depth_in":0.1,"length_in":0.1,"total_weight_oz":0.1,"width_in":0.1},"type":"Box or pallet"}],"products":[{"id":0,"inventory_items":[{"expiration_date":"2019-08-24T14:15:22+00:00","id":0,"is_dangerous_goods":true,"lot":"22222","name":"Medium Blue T-Shirt","quantity":0,"quantity_committed":0,"serial_numbers":["string"]}],"name":"Medium Blue T-Shirt","reference_id":"TShirtBlueM","sku":"TShirtBlueM"}],"recipient":{"address":{"address1":"100 Nowhere Blvd","address2":"Suite 100","city":"Gotham City","company_name":"Wayne Enterprises","country":"US","state":"NJ","zip_code":"07093"},"email":"john@example.com","full_name":"John Doe","name":"John Doe","phone_number":"555-555-5555"},"reference_id":"string","require_signature":true,"ship_option":"Standard","status":"None","status_details":[{"description":"string","exception_fulfillment_center_id":0,"extra_information":{"validation_messages":["string"]},"id":0,"inventory_id":0,"name":"string"}],"tracking":{"bol":"string","carrier":"USPS","carrier_service":"Priority","pro_number":"string","scac":"string","shipping_date":"2019-08-24T14:15:22+00:00","tracking_number":"860C8CDC8F0B4FC7AB69AC86C20539EC","tracking_url":"https://www.example.com/tracking?id=860C8CDC8F0B4FC7AB69AC86C20539EC"}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Shipment.ShipmentId.Bad.Request.Object"},"examples":{"default":{"summary":"","description":"","value":{"property1":["string"],"property2":["string"]}}}}}},"401":{"description":"No access right at this time"},"403":{"description":"No access"},"404":{"description":"Not Found"}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Orders"]},"put":{"summary":"Update a Shipment","parameters":[{"name":"shipmentId","in":"path","description":"The Shipment id to be updated","required":true,"schema":{"$ref":"#/components/schemas/Orders.Put.Api.Shipment.ShipmentId.ShipmentId.Integer"}},{"name":"shipbob_channel_id","in":"header","description":"Channel Id for Operation","required":true,"schema":{"$ref":"#/components/schemas/Orders.Put.Api.Shipment.ShipmentId.Shipbob.Channel.Id.Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Put.Api.Shipment.ShipmentId.OK.OneOfArray"},"examples":{"default":{"summary":"","description":"","value":[{"actual_fulfillment_date":"2019-08-24T14:15:22+00:00","created_date":"2019-08-24T14:15:22+00:00","delivery_date":"2019-08-24T14:15:22+00:00","estimated_fulfillment_date":"2019-08-24T14:15:22+00:00","estimated_fulfillment_date_status":"AwaitingInventoryAllocation","gift_message":"string","id":0,"insurance_value":0,"invoice_amount":0,"invoice_currency_code":"string","is_tracking_uploaded":true,"last_tracking_update_at":"2019-08-24T14:15:22+00:00","last_update_at":"2019-08-24T14:15:22+00:00","location":{"id":0,"name":"Cicero (IL)"},"measurements":{"depth_in":0,"length_in":0,"total_weight_oz":0,"width_in":0},"order_id":0,"package_material_type":"Unknown","parent_cartons":[{"barcode":"string","cartons":[{"barcode":"string","carton_details":[{"products":[{"id":0,"inventory_items":[{"expiration_date":"2019-08-24T14:15:22+00:00","id":0,"is_dangerous_goods":true,"lot":"22222","name":"Medium Blue T-Shirt","quantity":0,"quantity_committed":0,"serial_numbers":["string"]}],"name":"Medium Blue T-Shirt","reference_id":"TShirtBlueM","sku":"TShirtBlueM"}]}],"id":0,"measurements":{"depth_in":0.1,"length_in":0.1,"total_weight_oz":0.1,"width_in":0.1},"type":"Box or pallet"}],"measurements":{"depth_in":0.1,"length_in":0.1,"total_weight_oz":0.1,"width_in":0.1},"type":"Box or pallet"}],"products":[{"id":0,"inventory_items":[{"expiration_date":"2019-08-24T14:15:22+00:00","id":0,"is_dangerous_goods":true,"lot":"22222","name":"Medium Blue T-Shirt","quantity":0,"quantity_committed":0,"serial_numbers":["string"]}],"name":"Medium Blue T-Shirt","reference_id":"TShirtBlueM","sku":"TShirtBlueM"}],"recipient":{"address":{"address1":"100 Nowhere Blvd","address2":"Suite 100","city":"Gotham City","company_name":"Wayne Enterprises","country":"US","state":"NJ","zip_code":"07093"},"email":"john@example.com","full_name":"John Doe","name":"John Doe","phone_number":"555-555-5555"},"reference_id":"string","require_signature":true,"ship_option":"Standard","status":"None","status_details":[{"description":"string","exception_fulfillment_center_id":0,"extra_information":{"validation_messages":["string"]},"id":0,"inventory_id":0,"name":"string"}],"tracking":{"bol":"string","carrier":"USPS","carrier_service":"Priority","pro_number":"string","scac":"string","shipping_date":"2019-08-24T14:15:22+00:00","tracking_number":"860C8CDC8F0B4FC7AB69AC86C20539EC","tracking_url":"https://www.example.com/tracking?id=860C8CDC8F0B4FC7AB69AC86C20539EC"}}]}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Put.Api.Shipment.ShipmentId.Bad.Request.Object"},"examples":{"default":{"summary":"","description":"","value":{"property1":["string"],"property2":["string"]}}}}}},"401":{"description":"No access right at this time"},"403":{"description":"No access"},"404":{"description":"Not Found"}},"requestBody":{"description":"Shipment Information to be updated","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/Orders.UpdateShipmentModel"},"examples":{"default":{"summary":"","description":"","value":{"is_tracking_uploaded":true}}}},"application/json":{"schema":{"$ref":"#/components/schemas/Orders.UpdateShipmentModel"},"examples":{"default":{"summary":"","description":"","value":{"is_tracking_uploaded":true}}}},"text/json":{"schema":{"$ref":"#/components/schemas/Orders.UpdateShipmentModel"},"examples":{"default":{"summary":"","description":"","value":{"is_tracking_uploaded":true}}}},"application/*+json":{"schema":{"$ref":"#/components/schemas/Orders.UpdateShipmentModel"},"examples":{"default":{"summary":"","description":"","value":{"is_tracking_uploaded":true}}}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Orders"]}},"/2.0/shipment/{shipmentId}/logs":{"get":{"summary":"Get logs for one Shipment by Shipment Id","parameters":[{"name":"shipmentId","in":"path","description":"The shipment id to get","required":true,"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Shipment.ShipmentId.Logs.ShipmentId.Integer"}},{"name":"shipbob_channel_id","in":"header","description":"Channel Id for Operation","schema":{"$ref":"#/components/schemas/Orders.Get.Api.Shipment.ShipmentId.Logs.Shipbob.Channel.Id.Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.ShipmentLogViewModelArray"},"examples":{"default":{"summary":"","description":"","value":[{"log_type_id":0,"log_type_name":"string","log_type_text":"string","metadata":{"property1":"string","property2":"string"},"timestamp":"2019-08-24T14:15:22+00:00"}]}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Shipment.ShipmentId.Logs.Bad.Request.Object"},"examples":{"default":{"summary":"","description":"","value":{"property1":["string"],"property2":["string"]}}}}}},"401":{"description":"No access right at this time"},"403":{"description":"No access"},"404":{"description":"Not Found"}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Orders"]}},"/2.0/shipment/cancelbulk":{"post":{"summary":"Cancel multiple Shipments by Shipment Id","parameters":[{"name":"shipbob_channel_id","in":"header","description":"Channel ID for Operation","required":true,"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Shipment.Cancelbulk.Shipbob.Channel.Id.Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.CanceledShipmentsViewModel"},"examples":{"default":{"summary":"","description":"","value":{"results":[{"action":"Cancel","is_success":true,"reason":"string","shipment_id":0}]}}}}}},"401":{"description":"No access right at this time"},"403":{"description":"No access"},"422":{"description":"Client Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Shipment.Cancelbulk.Unprocessable.Entity.Object"},"examples":{"default":{"summary":"","description":"","value":{"property1":["string"],"property2":["string"]}}}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Shipment.Cancelbulk.Internal.Server.Error.Object"},"examples":{"default":{"summary":"","description":"","value":{"property1":["string"],"property2":["string"]}}}}}}},"requestBody":{"description":"The shipment IDs to cancel","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/Orders.CancelShipmentsModel"},"examples":{"default":{"summary":"","description":"","value":{"shipment_ids":[0]}}}},"application/json":{"schema":{"$ref":"#/components/schemas/Orders.CancelShipmentsModel"},"examples":{"default":{"summary":"","description":"","value":{"shipment_ids":[0]}}}},"text/json":{"schema":{"$ref":"#/components/schemas/Orders.CancelShipmentsModel"},"examples":{"default":{"summary":"","description":"","value":{"shipment_ids":[0]}}}},"application/*+json":{"schema":{"$ref":"#/components/schemas/Orders.CancelShipmentsModel"},"examples":{"default":{"summary":"","description":"","value":{"shipment_ids":[0]}}}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Orders"]}},"/2.0/order/{orderId}/shipment/{shipmentId}/timeline":{"get":{"summary":"Get one Shipment's status timeline by Order Id and Shipment Id","parameters":[{"name":"orderId","in":"path","description":"The order id to get the shipment for","required":true,"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.Timeline.OrderId.Integer"}},{"name":"shipmentId","in":"path","description":"The shipment id to get","required":true,"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.Timeline.ShipmentId.Integer"}},{"name":"shipbob_channel_id","in":"header","description":"Channel Id for Operation","schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.Timeline.Shipbob.Channel.Id.Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.ShipmentLogViewModelArray"},"examples":{"default":{"summary":"","description":"","value":[{"log_type_id":0,"log_type_name":"string","log_type_text":"string","metadata":{"property1":"string","property2":"string"},"timestamp":"2019-08-24T14:15:22+00:00"}]}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.Timeline.Bad.Request.Object"},"examples":{"default":{"summary":"","description":"","value":{"property1":["string"],"property2":["string"]}}}}}},"401":{"description":"No access right at this time"},"403":{"description":"No access"},"404":{"description":"Not Found"}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Orders"]}},"/2.0/order/{orderId}":{"get":{"summary":"Get Order","parameters":[{"name":"orderId","in":"path","description":"","required":true,"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.OrderId.OrderId.Integer"}},{"name":"shipbob_channel_id","in":"header","description":"Channel Id for Operation","schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.OrderId.Shipbob.Channel.Id.Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.OrderViewModel"},"examples":{"default":{"summary":"","description":"","value":{"channel":{"id":0,"name":"ShipBobs-Shopify-Store"},"created_date":"2019-08-24T14:15:22+00:00","financials":{"total_price":0.1},"gift_message":"string","id":0,"order_number":"string","products":[{"external_line_id":0,"gtin":"string","id":0,"quantity":0,"quantity_unit_of_measure_code":"string","reference_id":"TShirtBlueM","sku":"TShirtBlueM","unit_price":0.1,"upc":"string"}],"purchase_date":"2019-08-24T14:15:22+00:00","recipient":{"address":{"address1":"100 Nowhere Blvd","address2":"Suite 100","city":"Gotham City","company_name":"Wayne Enterprises","country":"US","state":"NJ","zip_code":"07093"},"email":"john@example.com","name":"John Doe","phone_number":"555-555-5555"},"reference_id":"string","retailer_program_data":{"addresses":[{"address1":"100 Nowhere Blvd","address2":"Suite 100","city":"Gotham City","company_name":"Wayne Enterprises","country":"US","state":"NJ","type":"MarkFor","zip_code":"07093"}],"customer_ticket_number":"string","delivery_date":"2019-08-24T14:15:22+00:00","department":"string","doNotShipBeforeDate":"2019-08-24T14:15:22+00:00","mark_for_store":"string","purchase_order_number":"string","retailer_program_type":"string","shipByDate":"2019-08-24T14:15:22+00:00"},"shipments":[{"actual_fulfillment_date":"2019-08-24T14:15:22+00:00","created_date":"2019-08-24T14:15:22+00:00","delivery_date":"2019-08-24T14:15:22+00:00","estimated_fulfillment_date":"2019-08-24T14:15:22+00:00","estimated_fulfillment_date_status":"AwaitingInventoryAllocation","gift_message":"string","id":0,"insurance_value":0,"invoice_amount":0,"invoice_currency_code":"string","is_tracking_uploaded":true,"last_tracking_update_at":"2019-08-24T14:15:22+00:00","last_update_at":"2019-08-24T14:15:22+00:00","location":{"id":0,"name":"Cicero (IL)"},"measurements":{"depth_in":0,"length_in":0,"total_weight_oz":0,"width_in":0},"order_id":0,"package_material_type":"Unknown","parent_cartons":[{"barcode":"string","cartons":[{"barcode":"string","carton_details":[{"products":[{"id":0,"inventory_items":[{"expiration_date":"2019-08-24T14:15:22+00:00","id":0,"is_dangerous_goods":true,"lot":"22222","name":"Medium Blue T-Shirt","quantity":0,"quantity_committed":0,"serial_numbers":["string"]}],"name":"Medium Blue T-Shirt","reference_id":"TShirtBlueM","sku":"TShirtBlueM"}]}],"id":0,"measurements":{"depth_in":0.1,"length_in":0.1,"total_weight_oz":0.1,"width_in":0.1},"type":"Box or pallet"}],"measurements":{"depth_in":0.1,"length_in":0.1,"total_weight_oz":0.1,"width_in":0.1},"type":"Box or pallet"}],"products":[{"id":0,"inventory_items":[{"expiration_date":"2019-08-24T14:15:22+00:00","id":0,"is_dangerous_goods":true,"lot":"22222","name":"Medium Blue T-Shirt","quantity":0,"quantity_committed":0,"serial_numbers":["string"]}],"name":"Medium Blue T-Shirt","reference_id":"TShirtBlueM","sku":"TShirtBlueM"}],"recipient":{"address":{"address1":"100 Nowhere Blvd","address2":"Suite 100","city":"Gotham City","company_name":"Wayne Enterprises","country":"US","state":"NJ","zip_code":"07093"},"email":"john@example.com","full_name":"John Doe","name":"John Doe","phone_number":"555-555-5555"},"reference_id":"string","require_signature":true,"ship_option":"Standard","status":"None","status_details":[{"description":"string","exception_fulfillment_center_id":0,"extra_information":{"validation_messages":["string"]},"id":0,"inventory_id":0,"name":"string"}],"tracking":{"bol":"string","carrier":"USPS","carrier_service":"Priority","pro_number":"string","scac":"string","shipping_date":"2019-08-24T14:15:22+00:00","tracking_number":"860C8CDC8F0B4FC7AB69AC86C20539EC","tracking_url":"https://www.example.com/tracking?id=860C8CDC8F0B4FC7AB69AC86C20539EC"}}],"shipping_method":"Free 2-day Shipping","shipping_terms":{"carrier_type":"Parcel","payment_term":"Collect"},"status":"Processing","tags":[{"name":"Handling instructions","value":"Fragile"}],"type":"DTC"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.OrderId.Bad.Request.Object"},"examples":{"default":{"summary":"","description":"","value":{"property1":["string"],"property2":["string"]}}}}}},"401":{"description":"No access right at this time"},"403":{"description":"No access"},"404":{"description":"Not Found"}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Orders"]}},"/2.0/shipment/{shipmentId}/timeline":{"get":{"summary":"Get one Shipment's status timeline by Shipment Id","parameters":[{"name":"shipmentId","in":"path","description":"The shipment id to get","required":true,"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Shipment.ShipmentId.Timeline.ShipmentId.Integer"}},{"name":"shipbob_channel_id","in":"header","description":"Channel Id for Operation","schema":{"$ref":"#/components/schemas/Orders.Get.Api.Shipment.ShipmentId.Timeline.Shipbob.Channel.Id.Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.ShipmentLogViewModelArray"},"examples":{"default":{"summary":"","description":"","value":[{"log_type_id":0,"log_type_name":"string","log_type_text":"string","metadata":{"property1":"string","property2":"string"},"timestamp":"2019-08-24T14:15:22+00:00"}]}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Shipment.ShipmentId.Timeline.Bad.Request.Object"},"examples":{"default":{"summary":"","description":"","value":{"property1":["string"],"property2":["string"]}}}}}},"401":{"description":"No access right at this time"},"403":{"description":"No access"},"404":{"description":"Not Found"}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Orders"]}},"/2.0/order/{orderId}/shipment/{shipmentId}/logs":{"get":{"summary":"Get logs for one Shipment by Order Id and Shipment Id","parameters":[{"name":"orderId","in":"path","description":"The order id to get the shipment for","required":true,"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.Logs.OrderId.Integer"}},{"name":"shipmentId","in":"path","description":"The shipment id to get","required":true,"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.Logs.ShipmentId.Integer"}},{"name":"shipbob_channel_id","in":"header","description":"Channel Id for Operation","schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.Logs.Shipbob.Channel.Id.Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.ShipmentLogViewModelArray"},"examples":{"default":{"summary":"","description":"","value":[{"log_type_id":0,"log_type_name":"string","log_type_text":"string","metadata":{"property1":"string","property2":"string"},"timestamp":"2019-08-24T14:15:22+00:00"}]}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.Logs.Bad.Request.Object"},"examples":{"default":{"summary":"","description":"","value":{"property1":["string"],"property2":["string"]}}}}}},"401":{"description":"No access right at this time"},"403":{"description":"No access"},"404":{"description":"Not Found"}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Orders"]}},"/2.0/location":{"get":{"summary":"Get locations\n","parameters":[{"name":"IncludeInactive","in":"query","description":"Whether the inactive locations should be included or not\n","schema":{"$ref":"#/components/schemas/Locations.Get.1.0.Location.IncludeInactive.Boolean"},"examples":{"default":{"summary":"","description":"","value":"True"}}},{"name":"ReceivingEnabled","in":"query","description":"Return all the receiving enabled locations\n","schema":{"$ref":"#/components/schemas/Locations.Get.1.0.Location.ReceivingEnabled.Boolean"},"examples":{"default":{"summary":"","description":"","value":"True"}}},{"name":"AccessGranted","in":"query","description":"Return all the access granted locations\n","schema":{"$ref":"#/components/schemas/Locations.Get.1.0.Location.AccessGranted.Boolean"},"examples":{"default":{"summary":"","description":"","value":"True"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Locations.Get.1.0.Location.OK.OneOfArray"},"examples":{"default":{"summary":"","description":"","value":[{"abbreviation":"string","access_granted":true,"attributes":["string"],"id":0,"is_active":true,"is_receiving_enabled":true,"is_shipping_enabled":true,"name":"string","region":{"id":0,"name":"string"},"services":[{"address":{"address1":"string","address2":"string","city":"string","country":"string","email":"string","name":"string","phone_number":"string","state":"string","zip_code":"string"},"enabled":true,"service_type":"Receiving"}],"timezone":"string"}]}}}}},"401":{"description":"Authorization missing or invalid"},"403":{"description":"The provided credentials are not authorized to access this resource"}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Locations"]}},"/2.0/receiving":{"get":{"summary":"Get Multiple Warehouse Receiving Orders\n","parameters":[{"name":"Page","in":"query","description":"Page of WROs to get\n","schema":{"$ref":"#/components/schemas/Receiving.Get.2.0.Receiving.Page.Integer"}},{"name":"Limit","in":"query","description":"Number of WROs per page to request\n","schema":{"$ref":"#/components/schemas/Receiving.Get.2.0.Receiving.Limit.Integer"}},{"name":"IDs","in":"query","description":"Comma separated list of WRO IDs to filter by\n","schema":{"$ref":"#/components/schemas/Receiving.Get.2.0.Receiving.IDs.IntegerArray"},"examples":{"default":{"summary":"","description":"","value":[0]}}},{"name":"Statuses","in":"query","description":"Comma separated list of WRO statuses to filter by\n","schema":{"$ref":"#/components/schemas/Receiving.ReceivingStatusArray"},"examples":{"default":{"summary":"","description":"","value":["Awaiting"]}}},{"name":"InsertStartDate","in":"query","description":"Earliest date that a WRO was created\n","schema":{"$ref":"#/components/schemas/Receiving.Get.2.0.Receiving.InsertStartDate.String"},"examples":{"default":{"summary":"","description":"","value":"2019-08-24T14:15:22+00:00"}}},{"name":"InsertEndDate","in":"query","description":"Latest date that a WRO was created\n","schema":{"$ref":"#/components/schemas/Receiving.Get.2.0.Receiving.InsertEndDate.String"},"examples":{"default":{"summary":"","description":"","value":"2019-08-24T14:15:22+00:00"}}},{"name":"FulfillmentCenterIds","in":"query","description":"Comma separated list of WRO fulfillment center IDs to filter by\n","schema":{"$ref":"#/components/schemas/Receiving.Get.2.0.Receiving.FulfillmentCenterIds.IntegerArray"},"examples":{"default":{"summary":"","description":"","value":[0]}}},{"name":"PurchaseOrderNumbers","in":"query","description":"Comma separated list of WRO PO numbers to filter by\n","schema":{"$ref":"#/components/schemas/Receiving.Get.2.0.Receiving.PurchaseOrderNumbers.StringArray"},"examples":{"default":{"summary":"","description":"","value":["string"]}}},{"name":"ExternalSync","in":"query","description":"Flag to return external_sync_timestamp WROs\n","schema":{"$ref":"#/components/schemas/Receiving.Get.2.0.Receiving.ExternalSync.Boolean"},"examples":{"default":{"summary":"","description":"","value":"True"}}},{"name":"CompletedStartDate","in":"query","description":"Earliest date that a WRO was completed\n","schema":{"$ref":"#/components/schemas/Receiving.Get.2.0.Receiving.CompletedStartDate.String"},"examples":{"default":{"summary":"","description":"","value":"2019-08-24T14:15:22+00:00"}}},{"name":"CompletedEndDate","in":"query","description":"Latest date that a WRO was completed\n","schema":{"$ref":"#/components/schemas/Receiving.Get.2.0.Receiving.CompletedEndDate.String"},"examples":{"default":{"summary":"","description":"","value":"2020-08-24T14:15:22+00:00"}}}],"responses":{"200":{"description":"Success","headers":{"Page-Number":{"description":"Number of the current page\n","schema":{"$ref":"#/components/schemas/Receiving.Get.2.0.Receiving.OK.Page.Number.Int"}},"Total-Pages":{"description":"Total number of pages of results\n","schema":{"$ref":"#/components/schemas/Receiving.Get.2.0.Receiving.OK.Total.Pages.Int"}},"Total-Count":{"description":"Total number of results\n","schema":{"$ref":"#/components/schemas/Receiving.Get.2.0.Receiving.OK.Total.Count.Int"}},"Page-Size":{"description":"Number of results per page\n","schema":{"$ref":"#/components/schemas/Receiving.Get.2.0.Receiving.OK.Page.Size.Int"}},"Next-Page":{"description":"The href of the next page of results, if there is a next page\n","schema":{"$ref":"#/components/schemas/Receiving.Get.2.0.Receiving.OK.Next.Page.String"},"examples":{"default":{"summary":"","description":"","value":"string"}}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receiving.V2.WarehouseReceivingOrderViewModelArray"},"examples":{"default":{"summary":"","description":"","value":[{"box_labels_uri":"https://api.shipbob.com/1.0/receiving/1/labels","box_packaging_type":"EverythingInOneBox","expected_arrival_date":"2019-08-24T14:15:22+00:00","external_sync_timestamp":"2019-08-24T14:15:22+00:00","fulfillment_center":{"address1":"5900 W Ogden Ave","address2":"Suite 100","city":"Cicero","country":"USA","email":"example@example.com","id":0,"name":"Cicero (IL)","phone_number":"555-555-5555","state":"IL","timezone":"Central Standard Time","zip_code":"60804"},"id":0,"insert_date":"2019-08-24T14:15:22+00:00","inventory_quantities":[{"expected_quantity":0,"inventory_id":0,"received_quantity":0,"sku":"string","stowed_quantity":0}],"last_updated_date":"2019-08-24T14:15:22+00:00","package_type":"Package","purchase_order_number":"string","status":"Awaiting"}]}}}}},"401":{"description":"Authorization missing or invalid"},"403":{"description":"The provided credentials are not authorized to access this resource"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receiving.Get.2.0.Receiving.Not.Found.OneOf.ValidationProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","errors":{"property1":["string"],"property2":["string"]},"instance":"string","property1":{},"property2":{},"status":0,"title":"string","type":"string"}}}}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Receiving"]},"post":{"summary":"Create Warehouse Receiving Order\n","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receiving.V2.WarehouseReceivingOrderViewModel"},"examples":{"default":{"summary":"","description":"","value":{"box_labels_uri":"https://api.shipbob.com/1.0/receiving/1/labels","box_packaging_type":"EverythingInOneBox","expected_arrival_date":"2019-08-24T14:15:22+00:00","fulfillment_center":{"address1":"5900 W Ogden Ave","address2":"Suite 100","city":"Cicero","country":"USA","email":"example@example.com","id":0,"name":"Cicero (IL)","phone_number":"555-555-5555","state":"IL","timezone":"Central Standard Time","zip_code":"60804"},"id":0,"insert_date":"2019-08-24T14:15:22+00:00","inventory_quantities":[{"expected_quantity":0,"inventory_id":0,"received_quantity":0,"sku":"string","stowed_quantity":0}],"last_updated_date":"2019-08-24T14:15:22+00:00","package_type":"Package","purchase_order_number":"string","status":"Awaiting"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receiving.Post.2.0.Receiving.Bad.Request.Object"},"examples":{"default":{"summary":"","description":"","value":{"property1":["string"],"property2":["string"]}}}}}},"401":{"description":"Authorization missing or invalid"},"403":{"description":"The provided credentials are not authorized to access this resource"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receiving.Post.2.0.Receiving.Not.Found.OneOf.ValidationProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","errors":{"property1":["string"],"property2":["string"]},"instance":"string","property1":{},"property2":{},"status":0,"title":"string","type":"string"}}}}}}},"requestBody":{"description":"The receiving order to create","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/Receiving.CreateReceivingOrderModel"},"examples":{"default":{"summary":"","description":"","value":{"box_packaging_type":"EverythingInOneBox","boxes":[{"box_items":[{"inventory_id":0,"lot_date":"2019-08-24T14:15:22+00:00","lot_number":"2222","quantity":1}],"tracking_number":"860C8CDC8F0B4FC7AB69AC86C20539EC"}],"expected_arrival_date":"2019-08-24T14:15:22+00:00","fulfillment_center":{"id":0},"package_type":"Package","purchase_order_number":"string"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/Receiving.CreateReceivingOrderModel"},"examples":{"default":{"summary":"","description":"","value":{"box_packaging_type":"EverythingInOneBox","boxes":[{"box_items":[{"inventory_id":0,"lot_date":"2019-08-24T14:15:22+00:00","lot_number":"2222","quantity":1}],"tracking_number":"860C8CDC8F0B4FC7AB69AC86C20539EC"}],"expected_arrival_date":"2019-08-24T14:15:22+00:00","fulfillment_center":{"id":0},"package_type":"Package","purchase_order_number":"string"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/Receiving.CreateReceivingOrderModel"},"examples":{"default":{"summary":"","description":"","value":{"box_packaging_type":"EverythingInOneBox","boxes":[{"box_items":[{"inventory_id":0,"lot_date":"2019-08-24T14:15:22+00:00","lot_number":"2222","quantity":1}],"tracking_number":"860C8CDC8F0B4FC7AB69AC86C20539EC"}],"expected_arrival_date":"2019-08-24T14:15:22+00:00","fulfillment_center":{"id":0},"package_type":"Package","purchase_order_number":"string"}}}},"application/*+json":{"schema":{"$ref":"#/components/schemas/Receiving.CreateReceivingOrderModel"},"examples":{"default":{"summary":"","description":"","value":{"box_packaging_type":"EverythingInOneBox","boxes":[{"box_items":[{"inventory_id":0,"lot_date":"2019-08-24T14:15:22+00:00","lot_number":"2222","quantity":1}],"tracking_number":"860C8CDC8F0B4FC7AB69AC86C20539EC"}],"expected_arrival_date":"2019-08-24T14:15:22+00:00","fulfillment_center":{"id":0},"package_type":"Package","purchase_order_number":"string"}}}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Receiving"]}},"/2.0/fulfillmentCenter":{"get":{"summary":"Get Fulfillment Centers\n","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receiving.FulfillmentCenterViewModelArray"},"examples":{"default":{"summary":"","description":"","value":[{"address1":"5900 W Ogden Ave","address2":"Suite 100","city":"Cicero","country":"USA","email":"example@example.com","id":0,"name":"Cicero (IL)","phone_number":"555-555-5555","state":"IL","timezone":"Central Standard Time","zip_code":"60804"}]}}}}},"401":{"description":"Authorization missing or invalid"},"403":{"description":"The provided credentials are not authorized to access this resource"}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Receiving"]}},"/2.0/receiving/{id}/boxes":{"get":{"summary":"Get Warehouse Receiving Order Boxes\n","parameters":[{"name":"id","in":"path","description":"Id of the receiving order","required":true,"schema":{"$ref":"#/components/schemas/Receiving.Get.2.0.Receiving.Id.Boxes.Id.Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receiving.BoxViewModelArray"},"examples":{"default":{"summary":"","description":"","value":[{"arrived_date":"2019-08-24T14:15:22+00:00","box_id":0,"box_items":[{"inventory_id":0,"lot_date":"2019-08-24T14:15:22+00:00","lot_number":"string","quantity":0,"received_quantity":0,"stowed_quantity":0}],"box_number":0,"box_status":"Awaiting","counting_started_date":"2019-08-24T14:15:22+00:00","received_date":"2019-08-24T14:15:22+00:00","tracking_number":"860C8CDC8F0B4FC7AB69AC86C20539EC"}]}}}}},"401":{"description":"Authorization missing or invalid"},"403":{"description":"The provided credentials are not authorized to access this resource"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receiving.Get.2.0.Receiving.Id.Boxes.Not.Found.OneOf.ValidationProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","errors":{"property1":["string"],"property2":["string"]},"instance":"string","property1":{},"property2":{},"status":0,"title":"string","type":"string"}}}}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Receiving"]}},"/2.0/receiving/{id}/cancel":{"post":{"summary":"Cancel Warehouse Receiving Order\n","parameters":[{"name":"id","in":"path","description":"Id of the receiving order to cancel","required":true,"schema":{"$ref":"#/components/schemas/Receiving.Post.2.0.Receiving.Id.Cancel.Id.Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receiving.V2.WarehouseReceivingOrderViewModel"},"examples":{"default":{"summary":"","description":"","value":{"box_labels_uri":"https://api.shipbob.com/1.0/receiving/1/labels","box_packaging_type":"EverythingInOneBox","expected_arrival_date":"2019-08-24T14:15:22+00:00","fulfillment_center":{"address1":"5900 W Ogden Ave","address2":"Suite 100","city":"Cicero","country":"USA","email":"example@example.com","id":0,"name":"Cicero (IL)","phone_number":"555-555-5555","state":"IL","timezone":"Central Standard Time","zip_code":"60804"},"id":0,"insert_date":"2019-08-24T14:15:22+00:00","inventory_quantities":[{"expected_quantity":0,"inventory_id":0,"received_quantity":0,"sku":"string","stowed_quantity":0}],"last_updated_date":"2019-08-24T14:15:22+00:00","package_type":"Package","purchase_order_number":"string","status":"Awaiting"}}}}}},"401":{"description":"Authorization missing or invalid"},"403":{"description":"The provided credentials are not authorized to access this resource"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receiving.Post.2.0.Receiving.Id.Cancel.Not.Found.OneOf.ValidationProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","errors":{"property1":["string"],"property2":["string"]},"instance":"string","property1":{},"property2":{},"status":0,"title":"string","type":"string"}}}}}},"422":{"description":"Client Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receiving.Post.2.0.Receiving.Id.Cancel.Unprocessable.Entity.Object"},"examples":{"default":{"summary":"","description":"","value":{"property1":["string"],"property2":["string"]}}}}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Receiving"]}},"/2.0/receiving/{id}":{"get":{"summary":"Get Warehouse Receiving Order\n","parameters":[{"name":"id","in":"path","description":"Id of the receiving order\n","required":true,"schema":{"$ref":"#/components/schemas/Receiving.Get.2.0.Receiving.Id.Id.Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receiving.V2.WarehouseReceivingOrderViewModel"},"examples":{"default":{"summary":"","description":"","value":{"box_labels_uri":"https://api.shipbob.com/1.0/receiving/1/labels","box_packaging_type":"EverythingInOneBox","expected_arrival_date":"2019-08-24T14:15:22+00:00","external_sync_timestamp":"2019-08-24T14:15:22+00:00","fulfillment_center":{"address1":"5900 W Ogden Ave","address2":"Suite 100","city":"Cicero","country":"USA","email":"example@example.com","id":0,"name":"Cicero (IL)","phone_number":"555-555-5555","state":"IL","timezone":"Central Standard Time","zip_code":"60804"},"id":0,"insert_date":"2019-08-24T14:15:22+00:00","inventory_quantities":[{"expected_quantity":0,"inventory_id":0,"received_quantity":0,"sku":"string","stowed_quantity":0}],"last_updated_date":"2019-08-24T14:15:22+00:00","package_type":"Package","purchase_order_number":"string","status":"Awaiting"}}}}}},"401":{"description":"Authorization missing or invalid"},"403":{"description":"The provided credentials are not authorized to access this resource"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receiving.Get.2.0.Receiving.Id.Not.Found.OneOf.ValidationProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","errors":{"property1":["string"],"property2":["string"]},"instance":"string","property1":{},"property2":{},"status":0,"title":"string","type":"string"}}}}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Receiving"]}},"/2.0/receiving/{id}/labels":{"get":{"summary":"Get Warehouse Receiving Order Box Labels\n","parameters":[{"name":"id","in":"path","description":"Id of the receiving order","required":true,"schema":{"$ref":"#/components/schemas/Receiving.Get.2.0.Receiving.Id.Labels.Id.Integer"}}],"responses":{"200":{"description":"Success","content":{"application/pdf":{"schema":{"$ref":"#/components/schemas/Receiving.Get.2.0.Receiving.Id.Labels.OK.String"},"examples":{"default":{"summary":"","description":"","value":"string"}}},"application/json":{"schema":{"$ref":"#/components/schemas/Receiving.Get.2.0.Receiving.Id.Labels.OK.String"},"examples":{"default":{"summary":"","description":"","value":"string"}}}}},"400":{"description":"Bad Request","content":{"application/pdf":{"schema":{"$ref":"#/components/schemas/Receiving.Get.2.0.Receiving.Id.Labels.Bad.Request.OneOf.ValidationProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","errors":{"property1":["string"],"property2":["string"]},"instance":"string","property1":{},"property2":{},"status":0,"title":"string","type":"string"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/Receiving.Get.2.0.Receiving.Id.Labels.Bad.Request.OneOf.ValidationProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","errors":{"property1":["string"],"property2":["string"]},"instance":"string","property1":{},"property2":{},"status":0,"title":"string","type":"string"}}}}}},"401":{"description":"Authorization missing or invalid"},"403":{"description":"The provided credentials are not authorized to access this resource"},"404":{"description":"Not Found","content":{"application/pdf":{"schema":{"$ref":"#/components/schemas/Receiving.Get.2.0.Receiving.Id.Labels.Not.Found.OneOf.ValidationProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","errors":{"property1":["string"],"property2":["string"]},"instance":"string","property1":{},"property2":{},"status":0,"title":"string","type":"string"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/Receiving.Get.2.0.Receiving.Id.Labels.Not.Found.OneOf.ValidationProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","errors":{"property1":["string"],"property2":["string"]},"instance":"string","property1":{},"property2":{},"status":0,"title":"string","type":"string"}}}}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Receiving"]}},"/2.0/return/{id}/cancel":{"post":{"summary":"Cancel Return Order\n","parameters":[{"name":"id","in":"path","description":"Id of the return order","required":true,"schema":{"$ref":"#/components/schemas/Returns.Post.1.0.Return.Id.Cancel.Id.Integer"}},{"name":"shipbob_channel_id","in":"header","description":"Channel Id for Operation","required":true,"schema":{"$ref":"#/components/schemas/Returns.Post.1.0.Return.Id.Cancel.Shipbob.Channel.Id.Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Returns.ReturnOrderViewModel"},"examples":{"default":{"summary":"","description":"","value":{"channel":{"id":0,"name":"ShipBobs-Shopify-Store"},"completed_date":"2019-08-24T14:15:22+00:00","customer_name":"string","fulfillment_center":{"id":0,"name":"Cicero (IL)"},"id":0,"insert_date":"2019-08-24T14:15:22+00:00","inventory":[{"action_requested":{"action":"Default","action_type":"InventoryDefault","instructions":"string"},"action_taken":[{"action":"Default","action_reason":"string","lot_information":[{"expiration_date":"2019-08-24T14:15:22+00:00","lot_number":"string","quantity_processed":0}],"quantity_processed":1}],"id":0,"name":"string","quantity":0}],"invoice_amount":0.1,"original_shipment_id":0,"reference_id":"string","return_type":"Regular","status":"AwaitingArrival","store_order_id":"string","tracking_number":"860C8CDC8F0B4FC7AB69AC86C20539EC","transactions":[{"amount":2.5,"transaction_type":"ReturnLabelInvoice"}]}}}}}},"401":{"description":"Authorization missing or invalid"},"403":{"description":"The provided credentials are not authorized to access this resource"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Returns.Post.1.0.Return.Id.Cancel.Not.Found.OneOf.ValidationProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","errors":{"property1":["string"],"property2":["string"]},"extensions":{"property1":{},"property2":{}},"instance":"string","status":0,"title":"string","type":"string"}}}}}},"422":{"description":"Client Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Returns.Post.1.0.Return.Id.Cancel.Unprocessable.Entity.OneOf.ValidationProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","errors":{"property1":["string"],"property2":["string"]},"extensions":{"property1":{},"property2":{}},"instance":"string","status":0,"title":"string","type":"string"}}}}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Returns"]}},"/2.0/return/{id}/statushistory":{"get":{"summary":"Get One Return's status history\n","parameters":[{"name":"id","in":"path","description":"Id of the return order","required":true,"schema":{"$ref":"#/components/schemas/Returns.Get.1.0.Return.Id.Statushistory.Id.Integer"}},{"name":"shipbob_channel_id","in":"header","description":"Channel Id for Operation","schema":{"$ref":"#/components/schemas/Returns.Get.1.0.Return.Id.Statushistory.Shipbob.Channel.Id.Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Returns.ReturnOrderStatusHistoryViewModelArray"},"examples":{"default":{"summary":"","description":"","value":[{"status":"AwaitingArrival","time_stamp":"2019-08-24T14:15:22+00:00"}]}}}}},"401":{"description":"Authorization missing or invalid"},"403":{"description":"The provided credentials are not authorized to access this resource"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Returns.Get.1.0.Return.Id.Statushistory.Not.Found.OneOf.ValidationProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","errors":{"property1":["string"],"property2":["string"]},"extensions":{"property1":{},"property2":{}},"instance":"string","status":0,"title":"string","type":"string"}}}}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Returns"]}},"/2.0/return":{"get":{"summary":"Get Return Orders\n","parameters":[{"name":"Page","in":"query","description":"Page of return orders to get","schema":{"$ref":"#/components/schemas/Returns.Get.1.0.Return.Page.Integer"}},{"name":"Limit","in":"query","description":"Amount of return orders per page to request","schema":{"$ref":"#/components/schemas/Returns.Get.1.0.Return.Limit.Integer"}},{"name":"SortOrder","in":"query","description":"Order to sort results by","schema":{"$ref":"#/components/schemas/Returns.SortOrder"},"examples":{"default":{"summary":"","description":"","value":"Newest"}}},{"name":"StartDate","in":"query","description":"Start date to filter orders inserted later than","schema":{"$ref":"#/components/schemas/Returns.Get.1.0.Return.StartDate.String"},"examples":{"default":{"summary":"","description":"","value":"2019-08-24T14:15:22+00:00"}}},{"name":"EndDate","in":"query","description":"End date to filter orders inserted earlier than","schema":{"$ref":"#/components/schemas/Returns.Get.1.0.Return.EndDate.String"},"examples":{"default":{"summary":"","description":"","value":"2019-08-24T14:15:22+00:00"}}},{"name":"IDs","in":"query","description":"Comma separated list of return orders ids to filter by","schema":{"$ref":"#/components/schemas/Returns.Get.1.0.Return.IDs.IntegerArray"},"examples":{"default":{"summary":"","description":"","value":[0]}}},{"name":"ReferenceIds","in":"query","description":"Comma separated list of reference ids to filter by","schema":{"$ref":"#/components/schemas/Returns.Get.1.0.Return.ReferenceIds.StringArray"},"examples":{"default":{"summary":"","description":"","value":["string"]}}},{"name":"Status","in":"query","description":"Comma separated list of statuses to filter by","schema":{"$ref":"#/components/schemas/Returns.ReturnStatusArray"},"examples":{"default":{"summary":"","description":"","value":["AwaitingArrival"]}}},{"name":"FulfillmentCenterIds","in":"query","description":"Comma separated list of destination fulfillment center IDs to filter by","schema":{"$ref":"#/components/schemas/Returns.Get.1.0.Return.FulfillmentCenterIds.IntegerArray"},"examples":{"default":{"summary":"","description":"","value":[0]}}},{"name":"TrackingNumbers","in":"query","description":"Comma separated list of tracking numbers to filter by","schema":{"$ref":"#/components/schemas/Returns.Get.1.0.Return.TrackingNumbers.StringArray"},"examples":{"default":{"summary":"","description":"","value":["string"]}}},{"name":"OriginalShipmentIds","in":"query","description":"Comma separated list of original shipment IDs to filter by","schema":{"$ref":"#/components/schemas/Returns.Get.1.0.Return.OriginalShipmentIds.IntegerArray"},"examples":{"default":{"summary":"","description":"","value":[0]}}},{"name":"InventoryIds","in":"query","description":"Comma separated list of inventory IDs contained in return to filter by","schema":{"$ref":"#/components/schemas/Returns.Get.1.0.Return.InventoryIds.IntegerArray"},"examples":{"default":{"summary":"","description":"","value":[0]}}},{"name":"shipbob_channel_id","in":"header","description":"","schema":{"$ref":"#/components/schemas/Returns.Get.1.0.Return.Shipbob.Channel.Id.Integer"}}],"responses":{"200":{"description":"Success","headers":{"Page-Number":{"description":"Number of the current page","schema":{"$ref":"#/components/schemas/Returns.Get.1.0.Return.OK.Page.Number.Int"}},"Total-Pages":{"description":"Total number of pages of results","schema":{"$ref":"#/components/schemas/Returns.Get.1.0.Return.OK.Total.Pages.Int"}},"Total-Count":{"description":"Total number of results","schema":{"$ref":"#/components/schemas/Returns.Get.1.0.Return.OK.Total.Count.Int"}},"Page-Size":{"description":"Number of results per page","schema":{"$ref":"#/components/schemas/Returns.Get.1.0.Return.OK.Page.Size.Int"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Returns.ReturnOrderViewModelArray"},"examples":{"default":{"summary":"","description":"","value":[{"channel":{"id":0,"name":"ShipBobs-Shopify-Store"},"completed_date":"2019-08-24T14:15:22+00:00","customer_name":"string","fulfillment_center":{"id":0,"name":"Cicero (IL)"},"id":0,"insert_date":"2019-08-24T14:15:22+00:00","inventory":[{"action_requested":{"action":"Default","action_type":"InventoryDefault","instructions":"string"},"action_taken":[{"action":"Default","action_reason":"string","lot_information":[{"expiration_date":"2019-08-24T14:15:22+00:00","lot_number":"string","quantity_processed":0}],"quantity_processed":1}],"id":0,"name":"string","quantity":0}],"invoice_amount":0.1,"original_shipment_id":0,"reference_id":"string","return_type":"Regular","status":"AwaitingArrival","store_order_id":"string","tracking_number":"860C8CDC8F0B4FC7AB69AC86C20539EC","transactions":[{"amount":2.5,"transaction_type":"ReturnLabelInvoice"}]}]}}}}},"401":{"description":"Authorization missing or invalid"},"403":{"description":"The provided credentials are not authorized to access this resource"}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Returns"]},"post":{"summary":"Create Return Order\n","parameters":[{"name":"shipbob_channel_id","in":"header","description":"","required":true,"schema":{"$ref":"#/components/schemas/Returns.Post.Api.V1.Public.Create.Shipbob.Channel.Id.Integer"}},{"name":"creationSourceId","in":"header","description":"","schema":{"$ref":"#/components/schemas/Returns.Post.Api.V1.Public.Create.CreationSourceId.Integer"},"examples":{"default":{"summary":"","description":"","value":3}}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"401":{"description":"Authorization missing or invalid"},"403":{"description":"The provided credentials are not authorized to access this resource"}},"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Returns.CreateReturnRequest"},"examples":{"default":{"summary":"","description":"","value":{"fulfillmentCenter":{"id":0,"name":"string"},"inventory":[{"id":0,"lotDate":"2019-08-24T14:15:22+00:00","lotNumber":"string","quantity":0,"requestedAction":0}],"originalShipmentId":0,"referenceId":"string","trackingNumber":"string"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/Returns.CreateReturnRequest"},"examples":{"default":{"summary":"","description":"","value":{"fulfillmentCenter":{"id":0,"name":"string"},"inventory":[{"id":0,"lotDate":"2019-08-24T14:15:22+00:00","lotNumber":"string","quantity":0,"requestedAction":0}],"originalShipmentId":0,"referenceId":"string","trackingNumber":"string"}}}},"application/*+json":{"schema":{"$ref":"#/components/schemas/Returns.CreateReturnRequest"},"examples":{"default":{"summary":"","description":"","value":{"fulfillmentCenter":{"id":0,"name":"string"},"inventory":[{"id":0,"lotDate":"2019-08-24T14:15:22+00:00","lotNumber":"string","quantity":0,"requestedAction":0}],"originalShipmentId":0,"referenceId":"string","trackingNumber":"string"}}}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Returns"]}},"/2.0/return/{id}":{"put":{"summary":"Modify Return Order\n","parameters":[{"name":"id","in":"path","description":"Id of the return order","required":true,"schema":{"$ref":"#/components/schemas/Returns.Put.1.0.Return.Id.Id.Integer"}},{"name":"shipbob_channel_id","in":"header","description":"Channel Id for Operation","required":true,"schema":{"$ref":"#/components/schemas/Returns.Put.1.0.Return.Id.Shipbob.Channel.Id.Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Returns.ReturnOrderViewModel"},"examples":{"default":{"summary":"","description":"","value":{"channel":{"id":0,"name":"ShipBobs-Shopify-Store"},"completed_date":"2019-08-24T14:15:22+00:00","customer_name":"string","fulfillment_center":{"id":0,"name":"Cicero (IL)"},"id":0,"insert_date":"2019-08-24T14:15:22+00:00","inventory":[{"action_requested":{"action":"Default","action_type":"InventoryDefault","instructions":"string"},"action_taken":[{"action":"Default","action_reason":"string","lot_information":[{"expiration_date":"2019-08-24T14:15:22+00:00","lot_number":"string","quantity_processed":0}],"quantity_processed":1}],"id":0,"name":"string","quantity":0}],"invoice_amount":0.1,"original_shipment_id":0,"reference_id":"string","return_type":"Regular","status":"AwaitingArrival","store_order_id":"string","tracking_number":"860C8CDC8F0B4FC7AB69AC86C20539EC","transactions":[{"amount":2.5,"transaction_type":"ReturnLabelInvoice"}]}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Returns.Put.1.0.Return.Id.Bad.Request.OneOf.ValidationProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","errors":{"property1":["string"],"property2":["string"]},"extensions":{"property1":{},"property2":{}},"instance":"string","status":0,"title":"string","type":"string"}}}}}},"401":{"description":"Authorization missing or invalid"},"403":{"description":"The provided credentials are not authorized to access this resource"},"422":{"description":"Client Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Returns.Put.1.0.Return.Id.Unprocessable.Entity.OneOf.ValidationProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","errors":{"property1":["string"],"property2":["string"]},"extensions":{"property1":{},"property2":{}},"instance":"string","status":0,"title":"string","type":"string"}}}}}}},"requestBody":{"description":"Model defining the return","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/Returns.CreateReturnViewModel"},"examples":{"default":{"summary":"","description":"","value":{"fulfillment_center":{"id":0,"name":"Cicero (IL)"},"inventory":[{"id":111222,"quantity":1,"requested_action":"Default"}],"original_shipment_id":123456,"reference_id":"ShipBob_Return_123","tracking_number":"1Z9999999999999999"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/Returns.CreateReturnViewModel"},"examples":{"default":{"summary":"","description":"","value":{"fulfillment_center":{"id":0,"name":"Cicero (IL)"},"inventory":[{"id":111222,"quantity":1,"requested_action":"Default"}],"original_shipment_id":123456,"reference_id":"ShipBob_Return_123","tracking_number":"1Z9999999999999999"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/Returns.CreateReturnViewModel"},"examples":{"default":{"summary":"","description":"","value":{"fulfillment_center":{"id":0,"name":"Cicero (IL)"},"inventory":[{"id":111222,"quantity":1,"requested_action":"Default"}],"original_shipment_id":123456,"reference_id":"ShipBob_Return_123","tracking_number":"1Z9999999999999999"}}}},"application/*+json":{"schema":{"$ref":"#/components/schemas/Returns.CreateReturnViewModel"},"examples":{"default":{"summary":"","description":"","value":{"fulfillment_center":{"id":0,"name":"Cicero (IL)"},"inventory":[{"id":111222,"quantity":1,"requested_action":"Default"}],"original_shipment_id":123456,"reference_id":"ShipBob_Return_123","tracking_number":"1Z9999999999999999"}}}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Returns"]},"get":{"summary":"Get Return Order\n","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"$ref":"#/components/schemas/Returns.Get.Api.Public.Id.Id.Integer"}},{"name":"api-version","in":"query","description":"The requested API version","schema":{"$ref":"#/components/schemas/Returns.Get.Api.Public.Id.Api.Version.String"},"examples":{"default":{"summary":"","description":"","value":1}}},{"name":"shipbob_channel_id","in":"header","description":"","schema":{"$ref":"#/components/schemas/Returns.Get.Api.Public.Id.Shipbob.Channel.Id.Integer"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"401":{"description":"Authorization missing or invalid"},"403":{"description":"The provided credentials are not authorized to access this resource"},"404":{"description":"Resource Not Found"}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Returns"]}},"/2.0/product/{productId}":{"get":{"summary":"Get Product\n","parameters":[{"name":"productId","in":"path","description":"","required":true,"schema":{"$ref":"#/components/schemas/Products.Get.Api.Product.ProductId.ProductId.Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.ProductViewModel"},"examples":{"default":{"summary":"","description":"","value":{"category":{"id":0,"name":"string"},"created_on":"2019-08-24T14:15:22+00:00","id":0,"name":"string","sub_category":{"id":0,"name":"string"},"type":"string","updated_on":"2019-08-24T14:15:22+00:00","user_id":0,"variants":[{"associated_bundles":[{"product_id":0,"product_name":"string","quantity":0,"variant_id":0,"variant_sku":"string"}],"barcode":"string","bundle_definition":[{"product_id":0,"quantity":0,"variant_id":0,"variant_name":"string","variant_sku":"string"}],"channel_metadata":[{"channel_id":0,"channel_name":"string","currency":"string","id":0,"is_inventory_sync_enabled":true,"legacy_product_id":0,"platform":"string","platform_identifier":"string","platform_inventory_item_id":"string","price":0.1,"seller_sku":"string"}],"created_on":"2019-08-24T14:15:22+00:00","customs":{"country_code_of_origin":"string","currency":"string","description":"string","hs_tariff_code":"string","is321_eligible":true,"value":0},"dimension":{"height":0.1,"length":0.1,"unit":"string","width":0.1},"fulfillment_settings":{"dangerous_goods":true,"is_bpm_parcel":true,"is_case_pick":true,"msds_url":"string","requires_prop65":true,"serial_scan":{"exact_character_length":0,"is_enabled":true,"prefix":"string","suffix":"string"}},"gtin":"string","id":0,"inventory":{"inventory_id":0,"on_hand_qty":0},"is_digital":true,"lot_information":{"is_lot":true,"minimum_shelf_life_days":0},"name":"string","packaging_material_type":{"id":0,"name":"string"},"packaging_requirement":{"id":0,"name":"string"},"return_preferences":{"backup_action":{"id":0,"name":"string"},"instructions":"string","primary_action":{"id":0,"name":"string"},"return_to_sender_backup_action":{"id":0,"name":"string"},"return_to_sender_primary_action":{"id":0,"name":"string"}},"sku":"string","status":"string","upc":"string","updated_on":"2019-08-24T14:15:22+00:00","weight":{"unit":"string","weight":0.1}}]}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.Get.Api.Product.ProductId.Bad.Request.Object"},"examples":{"default":{"summary":"","description":"","value":{"property1":["string"],"property2":["string"]}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.Get.Api.Product.ProductId.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Products"]},"patch":{"summary":"Update a single product with Json Merge Patch functionality\n","description":"Updates a single product. This endpoint supports Json Merge Patch functionality, which allows partial updates to be made to the product. The endpoint will only update the fields that are provided in the request. For updating variants, you mnust include the ID of the variant that you would like to update.\n","parameters":[{"name":"productId","in":"path","description":"The product identifier\n","required":true,"schema":{"$ref":"#/components/schemas/Products.Patch.Api.V3.Product.ProductId.ProductId.Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.ProductViewModel"},"examples":{"default":{"summary":"","description":"","value":{"category":{"id":0,"name":"string"},"created_on":"2019-08-24T14:15:22+00:00","id":0,"name":"string","sub_category":{"id":0,"name":"string"},"taxonomy":{"id":0,"name":"string","parent_id":0,"parent_name":"string","path":"string"},"type":"string","updated_on":"2019-08-24T14:15:22+00:00","user_id":0,"variants":[{"additional_hazmat_attributes":{"charge_state_percentage":0.1,"container_metal":true,"lithium_battery_packaging":"string","lithium_battery_type":"string","magnet":true,"net_volume":0.1,"net_weight":0.1},"associated_bundles":[{"product_id":0,"product_name":"string","quantity":0,"variant_id":0,"variant_sku":"string"}],"barcode":"string","barcode_sticker_url":"string","bundle_definition":[{"product_id":0,"quantity":0,"variant_id":0,"variant_name":"string","variant_sku":"string"}],"channel_metadata":[{"channel_id":0,"channel_name":"string","currency":"string","id":0,"is_inventory_sync_enabled":true,"legacy_product_id":0,"platform":"string","platform_identifier":"string","platform_inventory_item_id":"string","price":0.1,"seller_sku":"string"}],"created_on":"2019-08-24T14:15:22+00:00","customs":{"country_code_of_origin":"string","currency":"string","description":"string","hs_tariff_code":"string","is321_eligible":true,"value":0},"dimension":{"height":0.1,"is_locked":true,"length":0.1,"source":"string","unit":"string","width":0.1},"fulfillment_settings":{"dangerous_goods":true,"is_bpm_parcel":true,"is_case_pick":true,"msds_url":"string","requires_prop65":true,"serial_scan":{"exact_character_length":0,"is_enabled":true,"prefix":"string","suffix":"string"}},"gtin":"string","id":0,"inventory":{"inventory_id":0,"on_hand_qty":0},"is_digital":true,"is_image_uploaded":true,"lot_information":{"is_lot":true,"minimum_shelf_life_days":0},"merge_children":[{"channel_ids":[0],"completed_at":"2019-08-24T14:15:22+00:00","inventory_id":0,"variant_id":0,"variant_name":"string"}],"name":"string","packaging_material_type":{"id":0,"name":"string"},"packaging_requirement":{"id":0,"name":"string"},"return_preferences":{"backup_action":{"id":0,"name":"string"},"instructions":"string","primary_action":{"id":0,"name":"string"},"return_to_sender_backup_action":{"id":0,"name":"string"},"return_to_sender_primary_action":{"id":0,"name":"string"}},"reviews_pending":["string"],"sku":"string","status":"string","upc":"string","updated_on":"2019-08-24T14:15:22+00:00","weight":{"unit":"string","weight":0.1}}]}}}}}}},"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.UpdateProductRequestModelV3"},"examples":{"default":{"summary":"","description":"","value":{"category_id":0,"name":"string","sub_category_id":0,"taxonomy_id":0,"type_id":0,"variants":[{"additional_hazmat_attributes":{"charge_state_percentage":0.1,"container_metal":true,"lithium_battery_packaging":"string","lithium_battery_type":"string","magnet":true,"net_volume":0.1,"net_weight":0.1},"barcode":"string","barcode_sticker_url":"string","bundle_definition":[{"quantity":0,"variant_id":0}],"channel_metadata":[{"asin":"string","channel_id":0,"currency":"string","fnsku":"string","fulfillment_channel":"string","id":0,"is_inventory_sync_enabled":true,"legacy_product_id":0,"platform":"string","platform_identifier":"string","platform_inventory_item_id":"string","price":0.1,"seller_sku":"string"}],"customs":{"country_code_of_origin":"string","description":"string","hs_tariff_code":"string","is321_eligible":true,"value":0},"dimension":{"height":0.1,"length":0.1,"width":0.1},"fulfillment_settings":{"dangerous_goods":true,"is_bpm_parcel":true,"is_case_pick":true,"msds_url":"string","requires_prop65":true,"serial_scan":{"exact_character_length":0,"is_enabled":true,"prefix":"string","suffix":"string"}},"gtin":"string","id":0,"is_digital":true,"lot_information":{"is_lot":true,"minimum_shelf_life_days":0},"name":"string","packaging_material_type_id":0,"packaging_requirement_id":0,"return_preferences":{"backup_action_id":0,"instructions":"string","primary_action_id":0,"return_to_sender_backup_action_id":0,"return_to_sender_primary_action_id":0},"sku":"string","status_id":0,"upc":"string","weight":0.1}]}}}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Products"]}},"/2.0/product":{"get":{"summary":"Retrieves List of Products based on filters provided\n","parameters":[{"name":"Search","in":"query","description":"Search Products by name, sku, inventory id or product Id.\n","schema":{"$ref":"#/components/schemas/Products.Get.Api.Product.Search.String"}},{"name":"Barcode","in":"query","description":"Barcode Associated with variant\n","schema":{"$ref":"#/components/schemas/Products.Get.Api.Product.Barcode.String"}},{"name":"CategoryIds","in":"query","description":"List of Category Ids associated with product\n","schema":{"$ref":"#/components/schemas/Products.Get.Api.Product.CategoryIds.List.Int"}},{"name":"ChannelIds","in":"query","description":"Looks for Products variants by their channel IDs\n","schema":{"$ref":"#/components/schemas/Products.Get.Api.Product.ChannelIds.List.Int"}},{"name":"HasDigitalVariants","in":"query","description":"Looks for Products with/without digital variants\n","schema":{"$ref":"#/components/schemas/Products.Get.Api.Product.HasDigitalVariants.Boolean"}},{"name":"HasVariants","in":"query","description":"Looks for Products with/without variants\n","schema":{"$ref":"#/components/schemas/Products.Get.Api.Product.HasVariants.Boolean"}},{"name":"InventoryId","in":"query","description":"Looks for variants by its associated inventory id\n","schema":{"$ref":"#/components/schemas/Products.Get.Api.Product.InventoryId.List.Int"}},{"name":"LegacyIds","in":"query","description":"Looks for Products with by Legacy Product Id(s)\n","schema":{"$ref":"#/components/schemas/Products.Get.Api.Product.LegacyIds.List.Int"}},{"name":"Name","in":"query","description":"Looks for Products/Variants by name\n","schema":{"$ref":"#/components/schemas/Products.Get.Api.Product.Name.String"}},{"name":"OnHand","in":"query","description":"Looks for Products with inventory\n","schema":{"$ref":"#/components/schemas/Products.Get.Api.Product.OnHand.Integer"}},{"name":"PlatformIds","in":"query","description":"Looks for Products variants by their external Platform IDs\n","schema":{"$ref":"#/components/schemas/Products.Get.Api.Product.PlatformIds.List.String"}},{"name":"ProductId","in":"query","description":"Looks for Products with an assigned Id\n","schema":{"$ref":"#/components/schemas/Products.Get.Api.Product.ProductId.List.Int"}},{"name":"ProductType","in":"query","description":"Looks for Products by type\n","schema":{"$ref":"#/components/schemas/Products.Get.Api.Product.ProductType.Integer"}},{"name":"SalesChannel","in":"query","description":"Looks for Products variants assigned to a platform/sales channel \n","schema":{"$ref":"#/components/schemas/Products.Get.Api.Product.SalesChannel.List.String"}},{"name":"LastUpdatedTimestamp","in":"query","description":"Looks for Products that have been updated since the given date\n","schema":{"$ref":"#/components/schemas/Products.Get.Api.Product.LastUpdatedTimestamp.DateTime"}},{"name":"SellerSKUEvaludator","in":"query","description":"Looks for Products that match the provided Seller query\n","schema":{"$ref":"#/components/schemas/Products.Get.Api.Product.SellerSKUEvaludator.String"}},{"name":"SKU","in":"query","description":"Looks for Products that match the provided Sku query\n","schema":{"$ref":"#/components/schemas/Products.Get.Api.Product.SKU.String"}},{"name":"VariantId","in":"query","description":"Looks for products that contain a variant with the given ID\n","schema":{"$ref":"#/components/schemas/Products.Get.Api.Product.VariantId.List.Integer"}},{"name":"VariantStatus","in":"query","description":"Looks for Products with variants that contain provided status\n","schema":{"$ref":"#/components/schemas/Products.Get.Api.Product.VariantStatus.String"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.ProductViewModelArray"},"examples":{"default":{"summary":"","description":"","value":[{"category":{"id":0,"name":"string"},"created_on":"2019-08-24T14:15:22+00:00","id":0,"name":"string","sub_category":{"id":0,"name":"string"},"type":"string","updated_on":"2019-08-24T14:15:22+00:00","user_id":0,"variants":[{"associated_bundles":[{"product_id":0,"product_name":"string","quantity":0,"variant_id":0,"variant_sku":"string"}],"barcode":"string","bundle_definition":[{"product_id":0,"quantity":0,"variant_id":0,"variant_name":"string","variant_sku":"string"}],"channel_metadata":[{"channel_id":0,"channel_name":"string","currency":"string","id":0,"is_inventory_sync_enabled":true,"legacy_product_id":0,"platform":"string","platform_identifier":"string","platform_inventory_item_id":"string","price":0.1,"seller_sku":"string"}],"created_on":"2019-08-24T14:15:22+00:00","customs":{"country_code_of_origin":"string","currency":"string","description":"string","hs_tariff_code":"string","is321_eligible":true,"value":0},"dimension":{"height":0.1,"length":0.1,"unit":"string","width":0.1},"fulfillment_settings":{"dangerous_goods":true,"is_bpm_parcel":true,"is_case_pick":true,"msds_url":"string","requires_prop65":true,"serial_scan":{"exact_character_length":0,"is_enabled":true,"prefix":"string","suffix":"string"}},"gtin":"string","id":0,"inventory":{"inventory_id":0,"on_hand_qty":0},"is_digital":true,"lot_information":{"is_lot":true,"minimum_shelf_life_days":0},"name":"string","packaging_material_type":{"id":0,"name":"string"},"packaging_requirement":{"id":0,"name":"string"},"return_preferences":{"backup_action":{"id":0,"name":"string"},"instructions":"string","primary_action":{"id":0,"name":"string"},"return_to_sender_backup_action":{"id":0,"name":"string"},"return_to_sender_primary_action":{"id":0,"name":"string"}},"sku":"string","status":"string","upc":"string","updated_on":"2019-08-24T14:15:22+00:00","weight":{"unit":"string","weight":0.1}}]}]}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.Get.Api.Product.Bad.Request.Object"},"examples":{"default":{"summary":"","description":"","value":{"property1":["string"],"property2":["string"]}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.Get.Api.Product.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Products"]},"post":{"summary":"Create single product to the store\n","responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.ProductViewModel"},"examples":{"default":{"summary":"","description":"","value":{"category":{"id":0,"name":"string"},"created_on":"2019-08-24T14:15:22+00:00","id":0,"name":"string","sub_category":{"id":0,"name":"string"},"type":"string","updated_on":"2019-08-24T14:15:22+00:00","user_id":0,"variants":[{"associated_bundles":[{"product_id":0,"product_name":"string","quantity":0,"variant_id":0,"variant_sku":"string"}],"barcode":"string","bundle_definition":[{"product_id":0,"quantity":0,"variant_id":0,"variant_name":"string","variant_sku":"string"}],"channel_metadata":[{"channel_id":0,"channel_name":"string","currency":"string","id":0,"is_inventory_sync_enabled":true,"legacy_product_id":0,"platform":"string","platform_identifier":"string","platform_inventory_item_id":"string","price":0.1,"seller_sku":"string"}],"created_on":"2019-08-24T14:15:22+00:00","customs":{"country_code_of_origin":"string","currency":"string","description":"string","hs_tariff_code":"string","is321_eligible":true,"value":0},"dimension":{"height":0.1,"length":0.1,"unit":"string","width":0.1},"fulfillment_settings":{"dangerous_goods":true,"is_bpm_parcel":true,"is_case_pick":true,"msds_url":"string","requires_prop65":true,"serial_scan":{"exact_character_length":0,"is_enabled":true,"prefix":"string","suffix":"string"}},"gtin":"string","id":0,"inventory":{"inventory_id":0,"on_hand_qty":0},"is_digital":true,"lot_information":{"is_lot":true,"minimum_shelf_life_days":0},"name":"string","packaging_material_type":{"id":0,"name":"string"},"packaging_requirement":{"id":0,"name":"string"},"return_preferences":{"backup_action":{"id":0,"name":"string"},"instructions":"string","primary_action":{"id":0,"name":"string"},"return_to_sender_backup_action":{"id":0,"name":"string"},"return_to_sender_primary_action":{"id":0,"name":"string"}},"sku":"string","status":"string","upc":"string","updated_on":"2019-08-24T14:15:22+00:00","weight":{"unit":"string","weight":0.1}}]}}}}}}},"requestBody":{"description":"The product to add","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/Products.CreateProductRequestModel"},"examples":{"default":{"summary":"","description":"","value":{"category_id":0,"name":"string","sub_category_id":0,"type_id":0,"variants":[{"barcode":"string","bundle_definition":[{"quantity":0,"variant_id":0}],"channel_metadata":[{"asin":"string","channel_id":0,"currency":"string","fnsku":"string","fulfillment_channel":"string","id":0,"is_inventory_sync_enabled":true,"legacy_product_id":0,"platform":"string","platform_identifier":"string","platform_inventory_item_id":"string","price":0.1,"seller_sku":"string"}],"customs":{"country_code_of_origin":"string","description":"string","hs_tariff_code":"string","is321_eligible":true,"value":0},"dimension":{"height":0.1,"length":0.1,"width":0.1},"fulfillment_settings":{"dangerous_goods":true,"is_bpm_parcel":true,"is_case_pick":true,"msds_url":"string","requires_prop65":true,"serial_scan":{"exact_character_length":0,"is_enabled":true,"prefix":"string","suffix":"string"}},"gtin":"string","is_digital":true,"lot_information":{"is_lot":true,"minimum_shelf_life_days":0},"name":"string","packaging_material_type_id":0,"packaging_requirement_id":0,"return_preferences":{"backup_action_id":0,"instructions":"string","primary_action_id":0,"return_to_sender_backup_action_id":0,"return_to_sender_primary_action_id":0},"sku":"string","status_id":0,"upc":"string","weight":0.1}]}}}},"application/json":{"schema":{"$ref":"#/components/schemas/Products.CreateProductRequestModel"},"examples":{"default":{"summary":"","description":"","value":{"category_id":0,"name":"string","sub_category_id":0,"type_id":0,"variants":[{"barcode":"string","bundle_definition":[{"quantity":0,"variant_id":0}],"channel_metadata":[{"asin":"string","channel_id":0,"currency":"string","fnsku":"string","fulfillment_channel":"string","id":0,"is_inventory_sync_enabled":true,"legacy_product_id":0,"platform":"string","platform_identifier":"string","platform_inventory_item_id":"string","price":0.1,"seller_sku":"string"}],"customs":{"country_code_of_origin":"string","description":"string","hs_tariff_code":"string","is321_eligible":true,"value":0},"dimension":{"height":0.1,"length":0.1,"width":0.1},"fulfillment_settings":{"dangerous_goods":true,"is_bpm_parcel":true,"is_case_pick":true,"msds_url":"string","requires_prop65":true,"serial_scan":{"exact_character_length":0,"is_enabled":true,"prefix":"string","suffix":"string"}},"gtin":"string","is_digital":true,"lot_information":{"is_lot":true,"minimum_shelf_life_days":0},"name":"string","packaging_material_type_id":0,"packaging_requirement_id":0,"return_preferences":{"backup_action_id":0,"instructions":"string","primary_action_id":0,"return_to_sender_backup_action_id":0,"return_to_sender_primary_action_id":0},"sku":"string","status_id":0,"upc":"string","weight":0.1}]}}}},"text/json":{"schema":{"$ref":"#/components/schemas/Products.CreateProductRequestModel"},"examples":{"default":{"summary":"","description":"","value":{"category_id":0,"name":"string","sub_category_id":0,"type_id":0,"variants":[{"barcode":"string","bundle_definition":[{"quantity":0,"variant_id":0}],"channel_metadata":[{"asin":"string","channel_id":0,"currency":"string","fnsku":"string","fulfillment_channel":"string","id":0,"is_inventory_sync_enabled":true,"legacy_product_id":0,"platform":"string","platform_identifier":"string","platform_inventory_item_id":"string","price":0.1,"seller_sku":"string"}],"customs":{"country_code_of_origin":"string","description":"string","hs_tariff_code":"string","is321_eligible":true,"value":0},"dimension":{"height":0.1,"length":0.1,"width":0.1},"fulfillment_settings":{"dangerous_goods":true,"is_bpm_parcel":true,"is_case_pick":true,"msds_url":"string","requires_prop65":true,"serial_scan":{"exact_character_length":0,"is_enabled":true,"prefix":"string","suffix":"string"}},"gtin":"string","is_digital":true,"lot_information":{"is_lot":true,"minimum_shelf_life_days":0},"name":"string","packaging_material_type_id":0,"packaging_requirement_id":0,"return_preferences":{"backup_action_id":0,"instructions":"string","primary_action_id":0,"return_to_sender_backup_action_id":0,"return_to_sender_primary_action_id":0},"sku":"string","status_id":0,"upc":"string","weight":0.1}]}}}},"application/*+json":{"schema":{"$ref":"#/components/schemas/Products.CreateProductRequestModel"},"examples":{"default":{"summary":"","description":"","value":{"category_id":0,"name":"string","sub_category_id":0,"type_id":0,"variants":[{"barcode":"string","bundle_definition":[{"quantity":0,"variant_id":0}],"channel_metadata":[{"asin":"string","channel_id":0,"currency":"string","fnsku":"string","fulfillment_channel":"string","id":0,"is_inventory_sync_enabled":true,"legacy_product_id":0,"platform":"string","platform_identifier":"string","platform_inventory_item_id":"string","price":0.1,"seller_sku":"string"}],"customs":{"country_code_of_origin":"string","description":"string","hs_tariff_code":"string","is321_eligible":true,"value":0},"dimension":{"height":0.1,"length":0.1,"width":0.1},"fulfillment_settings":{"dangerous_goods":true,"is_bpm_parcel":true,"is_case_pick":true,"msds_url":"string","requires_prop65":true,"serial_scan":{"exact_character_length":0,"is_enabled":true,"prefix":"string","suffix":"string"}},"gtin":"string","is_digital":true,"lot_information":{"is_lot":true,"minimum_shelf_life_days":0},"name":"string","packaging_material_type_id":0,"packaging_requirement_id":0,"return_preferences":{"backup_action_id":0,"instructions":"string","primary_action_id":0,"return_to_sender_backup_action_id":0,"return_to_sender_primary_action_id":0},"sku":"string","status_id":0,"upc":"string","weight":0.1}]}}}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Products"]}},"/2.0/channel":{"get":{"summary":"Get channels","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Channels.ChannelArrayViewModel"},"examples":{"default":{"summary":"","description":"","value":[{"application_name":"SMA","id":128944,"name":"Privileged Access Token Wednesday, July 9, 2025","scopes":["pricing_read","fulfillments_write","returns_read","receiving_read","fulfillments_read","returns_write","locations_write","channels_read","webhooks_write","locations_read","orders_write","webhooks_read","inventory_read","billing_read","receiving_write","inventory_write","orders_read","products_read","products_write"]},{"application_name":"ShipBob","id":128943,"name":"ShipBob Default","scopes":["pricing_read","returns_read","receiving_read","fulfillments_read","channels_read","locations_read","webhooks_read","inventory_read","billing_read","orders_read","products_read"]}]}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Channels.ErrorResponse"},"examples":{"default":{"summary":"","description":"","value":{"property1":["string"],"property2":["string"]}}}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Channels"]}},"/2.0/shipment/:bulkUpdateTrackingUpload":{"post":{"summary":"Update Tracking Uploaded Status for Multiple Shipments by Shipment Id","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.BulkUpdateResponseModel"},"examples":{"default":{"summary":"","description":"","value":{"results":[{"error":{"code":"string","message":"string"},"isSuccess":true,"shipmentId":100810005}],"summary":{"failed":0,"successful":1,"total":1}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Orders.Post.Api.Shipment.BulkUpdateTrackingUpload.Bad.Request.String"},"examples":{"default":{"summary":"","description":"","value":"string"}}}}},"401":{"description":"No access right at this time"},"403":{"description":"No access"},"404":{"description":"Not Found"}},"requestBody":{"description":"","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/Orders.BulkUpdateTrackingUploadModel"},"examples":{"default":{"summary":"","description":"","value":{"is_tracking_uploaded":true,"shipment_ids":[100810005]}}}},"application/json":{"schema":{"$ref":"#/components/schemas/Orders.BulkUpdateTrackingUploadModel"},"examples":{"default":{"summary":"","description":"","value":{"is_tracking_uploaded":true,"shipment_ids":[100810005]}}}},"text/json":{"schema":{"$ref":"#/components/schemas/Orders.BulkUpdateTrackingUploadModel"},"examples":{"default":{"summary":"","description":"","value":{"is_tracking_uploaded":true,"shipment_ids":[100810005]}}}},"application/*+json":{"schema":{"$ref":"#/components/schemas/Orders.BulkUpdateTrackingUploadModel"},"examples":{"default":{"summary":"","description":"","value":{"is_tracking_uploaded":true,"shipment_ids":[100810005]}}}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Orders"]}},"/2.0/variant/{variantId}/channel-metadata/{channelMetadataId}":{"delete":{"summary":"Used to delete a specific channel metadata record from a variant by channel metadata ID\n","parameters":[{"name":"variantId","in":"path","description":"The ID of the variant to remove the metadata from\n","required":true,"schema":{"$ref":"#/components/schemas/Products.Delete.Api.Variant.VariantId.ChannelMetadata.ChannelMetadataId.VariantId.Integer"}},{"name":"channelMetadataId","in":"path","description":"The ID of the channel metadata record to delete\n","required":true,"schema":{"$ref":"#/components/schemas/Products.Delete.Api.Variant.VariantId.ChannelMetadata.ChannelMetadataId.ChannelMetadataId.Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.VariantViewModel"},"examples":{"default":{"summary":"","description":"","value":{"associated_bundles":[{"product_id":0,"product_name":"string","quantity":0,"variant_id":0,"variant_sku":"string"}],"barcode":"string","bundle_definition":[{"product_id":0,"quantity":0,"variant_id":0,"variant_name":"string","variant_sku":"string"}],"channel_metadata":[{"channel_id":0,"channel_name":"string","currency":"string","id":0,"is_inventory_sync_enabled":true,"legacy_product_id":0,"platform":"string","platform_identifier":"string","platform_inventory_item_id":"string","price":0.1,"seller_sku":"string"}],"created_on":"2019-08-24T14:15:22+00:00","customs":{"country_code_of_origin":"string","currency":"string","description":"string","hs_tariff_code":"string","is321_eligible":true,"value":0},"dimension":{"height":0.1,"length":0.1,"unit":"string","width":0.1},"fulfillment_settings":{"dangerous_goods":true,"is_bpm_parcel":true,"is_case_pick":true,"msds_url":"string","requires_prop65":true,"serial_scan":{"exact_character_length":0,"is_enabled":true,"prefix":"string","suffix":"string"}},"gtin":"string","id":0,"inventory":{"inventory_id":0,"on_hand_qty":0},"is_digital":true,"lot_information":{"is_lot":true,"minimum_shelf_life_days":0},"name":"string","packaging_material_type":{"id":0,"name":"string"},"packaging_requirement":{"id":0,"name":"string"},"return_preferences":{"backup_action":{"id":0,"name":"string"},"instructions":"string","primary_action":{"id":0,"name":"string"},"return_to_sender_backup_action":{"id":0,"name":"string"},"return_to_sender_primary_action":{"id":0,"name":"string"}},"sku":"string","status":"string","upc":"string","updated_on":"2019-08-24T14:15:22+00:00","weight":{"unit":"string","weight":0.1}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.Delete.Api.Variant.VariantId.ChannelMetadata.ChannelMetadataId.Bad.Request.Object"},"examples":{"default":{"summary":"","description":"","value":{"property1":["string"],"property2":["string"]}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.Delete.Api.Variant.VariantId.ChannelMetadata.ChannelMetadataId.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Products"]},"put":{"summary":"Update specific channel metadata record from a variant by channel metadata ID\n","parameters":[{"name":"variantId","in":"path","description":"The ID of the variant to update the metadata from\n","required":true,"schema":{"$ref":"#/components/schemas/Products.Put.Api.V2.Variant.VariantId.Channel.Metadata.ChannelMetadataId.VariantId.Integer"}},{"name":"channelMetadataId","in":"path","description":"The ID of the channel metadata record to update\n","required":true,"schema":{"$ref":"#/components/schemas/Products.Put.Api.V2.Variant.VariantId.Channel.Metadata.ChannelMetadataId.ChannelMetadataId.Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.VariantViewModel"},"examples":{"default":{"summary":"","description":"","value":{"additional_hazmat_attributes":{"charge_state_percentage":0.1,"container_metal":true,"lithium_battery_packaging":"string","lithium_battery_type":"string","magnet":true,"net_volume":0.1,"net_weight":0.1},"associated_bundles":[{"product_id":0,"product_name":"string","quantity":0,"variant_id":0,"variant_sku":"string"}],"barcode":"string","barcode_sticker_url":"string","bundle_definition":[{"product_id":0,"quantity":0,"variant_id":0,"variant_name":"string","variant_sku":"string"}],"channel_metadata":[{"channel_id":0,"channel_name":"string","currency":"string","id":0,"is_inventory_sync_enabled":true,"legacy_product_id":0,"platform":"string","platform_identifier":"string","platform_inventory_item_id":"string","price":0.1,"seller_sku":"string"}],"created_on":"2019-08-24T14:15:22+00:00","customs":{"country_code_of_origin":"string","currency":"string","description":"string","hs_tariff_code":"string","is321_eligible":true,"value":0},"dimension":{"height":0.1,"is_locked":true,"length":0.1,"source":"string","unit":"string","width":0.1},"fulfillment_settings":{"dangerous_goods":true,"is_bpm_parcel":true,"is_case_pick":true,"msds_url":"string","requires_prop65":true,"serial_scan":{"exact_character_length":0,"is_enabled":true,"prefix":"string","suffix":"string"}},"gtin":"string","id":0,"inventory":{"inventory_id":0,"on_hand_qty":0},"is_digital":true,"is_image_uploaded":true,"lot_information":{"is_lot":true,"minimum_shelf_life_days":0},"merge_children":[{"channel_ids":[0],"completed_at":"2019-08-24T14:15:22+00:00","inventory_id":0,"variant_id":0,"variant_name":"string"}],"name":"string","packaging_material_type":{"id":0,"name":"string"},"packaging_requirement":{"id":0,"name":"string"},"return_preferences":{"backup_action":{"id":0,"name":"string"},"instructions":"string","primary_action":{"id":0,"name":"string"},"return_to_sender_backup_action":{"id":0,"name":"string"},"return_to_sender_primary_action":{"id":0,"name":"string"}},"reviews_pending":["string"],"sku":"string","status":"string","upc":"string","updated_on":"2019-08-24T14:15:22+00:00","weight":{"unit":"string","weight":0.1}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.Put.Api.V2.Variant.VariantId.Channel.Metadata.ChannelMetadataId.Bad.Request.Object"},"examples":{"default":{"summary":"","description":"","value":{"property1":["string"],"property2":["string"]}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.Put.Api.V2.Variant.VariantId.Channel.Metadata.ChannelMetadataId.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}}}}},"requestBody":{"description":"","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/Products.Put.Api.V2.Variant.VariantId.Channel.Metadata.ChannelMetadataId.Request.OneOf.AmazonChannelMetadataRequestModel.BaseChannelMetadataRequestModel.BigCommerceChannelMetadataRequestModel.ShopifyChannelMetadataRequestModel"},"examples":{"default":{"summary":"","description":"","value":{"asin":"string","channel_id":0,"currency":"string","fnsku":"string","fulfillment_channel":"string","id":0,"is_inventory_sync_enabled":true,"legacy_product_id":0,"platform":"string","platform_identifier":"string","platform_inventory_item_id":"string","price":0.1,"seller_sku":"string"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/Products.Put.Api.V2.Variant.VariantId.Channel.Metadata.ChannelMetadataId.Request.OneOf.AmazonChannelMetadataRequestModel.BaseChannelMetadataRequestModel.BigCommerceChannelMetadataRequestModel.ShopifyChannelMetadataRequestModel"},"examples":{"default":{"summary":"","description":"","value":{"asin":"string","channel_id":0,"currency":"string","fnsku":"string","fulfillment_channel":"string","id":0,"is_inventory_sync_enabled":true,"legacy_product_id":0,"platform":"string","platform_identifier":"string","platform_inventory_item_id":"string","price":0.1,"seller_sku":"string"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/Products.Put.Api.V2.Variant.VariantId.Channel.Metadata.ChannelMetadataId.Request.OneOf.AmazonChannelMetadataRequestModel.BaseChannelMetadataRequestModel.BigCommerceChannelMetadataRequestModel.ShopifyChannelMetadataRequestModel"},"examples":{"default":{"summary":"","description":"","value":{"asin":"string","channel_id":0,"currency":"string","fnsku":"string","fulfillment_channel":"string","id":0,"is_inventory_sync_enabled":true,"legacy_product_id":0,"platform":"string","platform_identifier":"string","platform_inventory_item_id":"string","price":0.1,"seller_sku":"string"}}}},"application/*+json":{"schema":{"$ref":"#/components/schemas/Products.Put.Api.V2.Variant.VariantId.Channel.Metadata.ChannelMetadataId.Request.OneOf.AmazonChannelMetadataRequestModel.BaseChannelMetadataRequestModel.BigCommerceChannelMetadataRequestModel.ShopifyChannelMetadataRequestModel"},"examples":{"default":{"summary":"","description":"","value":{"asin":"string","channel_id":0,"currency":"string","fnsku":"string","fulfillment_channel":"string","id":0,"is_inventory_sync_enabled":true,"legacy_product_id":0,"platform":"string","platform_identifier":"string","platform_inventory_item_id":"string","price":0.1,"seller_sku":"string"}}}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Products"]}},"/2.0/taxonomy/{id}/parent":{"get":{"summary":"Get Taxonomy Parent by Id\n","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"$ref":"#/components/schemas/Products.Get.Api.V2.Taxonomy.Id.Parent.Id.Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.TaxonomyViewModel"},"examples":{"default":{"summary":"","description":"","value":{"children":[{"has_children":true,"id":0,"name":"string","path":"string"}],"id":0,"name":"string","parent":{"id":0,"name":"string","path":"string"},"path":"string"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.Get.Api.V2.Taxonomy.Id.Parent.Unauthorized.OneOf.ProblemDetails.HttpValidationProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.Get.Api.V2.Taxonomy.Id.Parent.Forbidden.OneOf.ProblemDetails.HttpValidationProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.Get.Api.V2.Taxonomy.Id.Parent.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}}}},"500":{"description":"Server Error"},"503":{"description":"Server Error"}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Products"]}},"/2.0/taxonomy":{"get":{"summary":"Get Taxonomies\n","parameters":[{"name":"search","in":"query","description":"","schema":{"$ref":"#/components/schemas/Products.Get.Api.V2.Taxonomy.Search.String"},"examples":{"default":{"summary":"","description":"","value":"string"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.TaxonomyViewModelArray"},"examples":{"default":{"summary":"","description":"","value":[{"children":[{"has_children":true,"id":0,"name":"string","path":"string"}],"id":0,"name":"string","parent":{"id":0,"name":"string","path":"string"},"path":"string"}]}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.Get.Api.V2.Taxonomy.Unauthorized.OneOf.ProblemDetails.HttpValidationProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.Get.Api.V2.Taxonomy.Forbidden.OneOf.ProblemDetails.HttpValidationProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}}}},"500":{"description":"Server Error"},"503":{"description":"Server Error"}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Products"]}},"/2.0/taxonomy/{id}":{"get":{"summary":"Get Taxonomy by Id\n","parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"$ref":"#/components/schemas/Products.Get.Api.V2.Taxonomy.Id.Id.Integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.TaxonomyViewModel"},"examples":{"default":{"summary":"","description":"","value":{"children":[{"has_children":true,"id":0,"name":"string","path":"string"}],"id":0,"name":"string","parent":{"id":0,"name":"string","path":"string"},"path":"string"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.Get.Api.V2.Taxonomy.Id.Unauthorized.OneOf.ProblemDetails.HttpValidationProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.Get.Api.V2.Taxonomy.Id.Forbidden.OneOf.ProblemDetails.HttpValidationProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.Get.Api.V2.Taxonomy.Id.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}}}},"500":{"description":"Server Error"},"503":{"description":"Server Error"}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Products"]}},"/2.0/packaging-requirement":{"get":{"summary":"Get Packaging Requirement\n","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.PackagingRequirementViewModelArray"},"examples":{"default":{"summary":"","description":"","value":[{"applicable_categories":[{"id":0,"sub_category_ids":[0]}],"applicable_packaging_material_types":[{"id":0,"name":"string"}],"description":"string","id":0,"name":"string"}]}}}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Products"]}},"/2.0/variant/{variantId}/channel-metadata":{"post":{"summary":"Used to Create a new Channel Metadata Entry for a given Variant\n","parameters":[{"name":"variantId","in":"path","description":"","required":true,"schema":{"$ref":"#/components/schemas/Products.Post.Api.Variant.VariantId.ChannelMetadata.VariantId.Integer"}}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.ProductViewModel"},"examples":{"default":{"summary":"","description":"","value":{"category":{"id":0,"name":"string"},"created_on":"2019-08-24T14:15:22+00:00","id":0,"name":"string","sub_category":{"id":0,"name":"string"},"type":"string","updated_on":"2019-08-24T14:15:22+00:00","user_id":0,"variants":[{"associated_bundles":[{"product_id":0,"product_name":"string","quantity":0,"variant_id":0,"variant_sku":"string"}],"barcode":"string","bundle_definition":[{"product_id":0,"quantity":0,"variant_id":0,"variant_name":"string","variant_sku":"string"}],"channel_metadata":[{"channel_id":0,"channel_name":"string","currency":"string","id":0,"is_inventory_sync_enabled":true,"legacy_product_id":0,"platform":"string","platform_identifier":"string","platform_inventory_item_id":"string","price":0.1,"seller_sku":"string"}],"created_on":"2019-08-24T14:15:22+00:00","customs":{"country_code_of_origin":"string","currency":"string","description":"string","hs_tariff_code":"string","is321_eligible":true,"value":0},"dimension":{"height":0.1,"length":0.1,"unit":"string","width":0.1},"fulfillment_settings":{"dangerous_goods":true,"is_bpm_parcel":true,"is_case_pick":true,"msds_url":"string","requires_prop65":true,"serial_scan":{"exact_character_length":0,"is_enabled":true,"prefix":"string","suffix":"string"}},"gtin":"string","id":0,"inventory":{"inventory_id":0,"on_hand_qty":0},"is_digital":true,"lot_information":{"is_lot":true,"minimum_shelf_life_days":0},"name":"string","packaging_material_type":{"id":0,"name":"string"},"packaging_requirement":{"id":0,"name":"string"},"return_preferences":{"backup_action":{"id":0,"name":"string"},"instructions":"string","primary_action":{"id":0,"name":"string"},"return_to_sender_backup_action":{"id":0,"name":"string"},"return_to_sender_primary_action":{"id":0,"name":"string"}},"sku":"string","status":"string","upc":"string","updated_on":"2019-08-24T14:15:22+00:00","weight":{"unit":"string","weight":0.1}}]}}}}}}},"requestBody":{"description":"","content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/Products.Post.Api.Variant.VariantId.ChannelMetadata.Request.OneOf.AmazonChannelMetadataRequestModel.BaseChannelMetadataRequestModel.BigCommerceChannelMetadataRequestModel.ShopifyChannelMetadataRequestModel"},"examples":{"default":{"summary":"","description":"","value":{"asin":"string","channel_id":0,"currency":"string","fnsku":"string","fulfillment_channel":"string","id":0,"is_inventory_sync_enabled":true,"legacy_product_id":0,"platform":"string","platform_identifier":"string","platform_inventory_item_id":"string","price":0.1,"seller_sku":"string"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/Products.Post.Api.Variant.VariantId.ChannelMetadata.Request.OneOf.AmazonChannelMetadataRequestModel.BaseChannelMetadataRequestModel.BigCommerceChannelMetadataRequestModel.ShopifyChannelMetadataRequestModel"},"examples":{"default":{"summary":"","description":"","value":{"asin":"string","channel_id":0,"currency":"string","fnsku":"string","fulfillment_channel":"string","id":0,"is_inventory_sync_enabled":true,"legacy_product_id":0,"platform":"string","platform_identifier":"string","platform_inventory_item_id":"string","price":0.1,"seller_sku":"string"}}}},"text/json":{"schema":{"$ref":"#/components/schemas/Products.Post.Api.Variant.VariantId.ChannelMetadata.Request.OneOf.AmazonChannelMetadataRequestModel.BaseChannelMetadataRequestModel.BigCommerceChannelMetadataRequestModel.ShopifyChannelMetadataRequestModel"},"examples":{"default":{"summary":"","description":"","value":{"asin":"string","channel_id":0,"currency":"string","fnsku":"string","fulfillment_channel":"string","id":0,"is_inventory_sync_enabled":true,"legacy_product_id":0,"platform":"string","platform_identifier":"string","platform_inventory_item_id":"string","price":0.1,"seller_sku":"string"}}}},"application/*+json":{"schema":{"$ref":"#/components/schemas/Products.Post.Api.Variant.VariantId.ChannelMetadata.Request.OneOf.AmazonChannelMetadataRequestModel.BaseChannelMetadataRequestModel.BigCommerceChannelMetadataRequestModel.ShopifyChannelMetadataRequestModel"},"examples":{"default":{"summary":"","description":"","value":{"asin":"string","channel_id":0,"currency":"string","fnsku":"string","fulfillment_channel":"string","id":0,"is_inventory_sync_enabled":true,"legacy_product_id":0,"platform":"string","platform_identifier":"string","platform_inventory_item_id":"string","price":0.1,"seller_sku":"string"}}}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Products"]}},"/2.0/inventory":{"get":{"summary":"  Get All Inventories\n","parameters":[{"name":"SearchBy","in":"query","description":"","schema":{"$ref":"#/components/schemas/Inventories.Get.Api.V3.Inventories.SearchBy.String"},"examples":{"default":{"summary":"","description":"","value":"string"}}},{"name":"FilterOperations","in":"query","description":"","schema":{"$ref":"#/components/schemas/Inventories.FilterOperationArray"},"examples":{"default":{"summary":"","description":"","value":[{"key":"string","rawValue":"string"}]}}},{"name":"InventoryIds","in":"query","description":"","schema":{"$ref":"#/components/schemas/Inventories.Get.Api.V3.Inventories.InventoryIds.IntegerArray"},"examples":{"default":{"summary":"","description":"","value":[0]}}},{"name":"IsActive","in":"query","description":"","schema":{"$ref":"#/components/schemas/Inventories.Get.Api.V3.Inventories.IsActive.Boolean"},"examples":{"default":{"summary":"","description":"","value":"True"}}},{"name":"IsDigital","in":"query","description":"","schema":{"$ref":"#/components/schemas/Inventories.Get.Api.V3.Inventories.IsDigital.Boolean"},"examples":{"default":{"summary":"","description":"","value":"True"}}},{"name":"PageSize","in":"query","description":"","schema":{"$ref":"#/components/schemas/Inventories.Get.Api.V3.Inventories.PageSize.Integer"}},{"name":"SortBy","in":"query","description":"","schema":{"$ref":"#/components/schemas/Inventories.Get.Api.V3.Inventories.SortBy.String"},"examples":{"default":{"summary":"","description":"","value":"string"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventories.InventoryResponsePagedResponse"},"examples":{"default":{"summary":"","description":"","value":{"first":"string","items":[{"barcode":"string","dimensions":{"height":0.1,"is_locked":true,"length":0.1,"unit":"string","validated":true,"width":0.1},"inventory_id":0,"is_case":true,"is_lot":true,"name":"string","sku":"string","user_id":0,"variant":{"hazmat":{"is_hazmat":true,"validated":true},"is_active":true,"is_bundle":true,"is_digital":true},"weight":{"unit":"string","value":0.1}}],"last":"string","next":"string","prev":"string"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventories.ProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventories.ProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventories.ProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}}}},"500":{"description":"Internal Server Error"},"503":{"description":"Service Unavailable"}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Inventory"]}},"/2.0/inventory-level/locations":{"get":{"summary":"  Get All Inventory Levels Grouped By Fulfillment Center\n","parameters":[{"name":"LocationType","in":"query","description":"","schema":{"$ref":"#/components/schemas/Inventories.Get.Api.V3.Inventory.Levels.Locations.LocationType.String"},"examples":{"default":{"summary":"","description":"","value":"string"}}},{"name":"LocationId","in":"query","description":"","schema":{"$ref":"#/components/schemas/Inventories.Get.Api.V3.Inventory.Levels.Locations.LocationId.Integer"}},{"name":"SearchBy","in":"query","description":"","schema":{"$ref":"#/components/schemas/Inventories.Get.Api.V3.Inventory.Levels.Locations.SearchBy.String"},"examples":{"default":{"summary":"","description":"","value":"string"}}},{"name":"InventoryIds","in":"query","description":"","schema":{"$ref":"#/components/schemas/Inventories.Get.Api.V3.Inventory.Levels.Locations.InventoryIds.IntegerArray"},"examples":{"default":{"summary":"","description":"","value":[0]}}},{"name":"IsActive","in":"query","description":"","schema":{"$ref":"#/components/schemas/Inventories.Get.Api.V3.Inventory.Levels.Locations.IsActive.Boolean"},"examples":{"default":{"summary":"","description":"","value":"True"}}},{"name":"IsDigital","in":"query","description":"","schema":{"$ref":"#/components/schemas/Inventories.Get.Api.V3.Inventory.Levels.Locations.IsDigital.Boolean"},"examples":{"default":{"summary":"","description":"","value":"True"}}},{"name":"PageSize","in":"query","description":"","schema":{"$ref":"#/components/schemas/Inventories.Get.Api.V3.Inventory.Levels.Locations.PageSize.Integer"}},{"name":"SortBy","in":"query","description":"","schema":{"$ref":"#/components/schemas/Inventories.Get.Api.V3.Inventory.Levels.Locations.SortBy.String"},"examples":{"default":{"summary":"","description":"","value":"string"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventories.InventoryQuantityFcResponsePagedResponse"},"examples":{"default":{"summary":"","description":"","value":{"first":"string","items":[{"inventory_id":0,"locations":[{"awaiting_quantity":0,"committed_quantity":0,"fulfillable_quantity":0,"internal_transfer_quantity":0,"location_id":0,"name":"string","on_hand_quantity":0}],"name":"string","sku":"string"}],"last":"string","next":"string","prev":"string"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventories.ProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventories.ProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventories.ProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}}}},"500":{"description":"Internal Server Error"},"503":{"description":"Service Unavailable"}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Inventory"]}},"/2.0/inventory/{inventoryId}":{"get":{"summary":"  Get Inventory\n","parameters":[{"name":"inventoryId","in":"path","description":"","required":true,"schema":{"$ref":"#/components/schemas/Inventories.Get.Api.V3.Inventories.InventoryId.InventoryId.Integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventories.InventoryResponse"},"examples":{"default":{"summary":"","description":"","value":{"barcode":"string","dimensions":{"height":0.1,"is_locked":true,"length":0.1,"unit":"string","validated":true,"width":0.1},"inventory_id":0,"is_case":true,"is_lot":true,"name":"string","sku":"string","user_id":0,"variant":{"hazmat":{"is_hazmat":true,"validated":true},"is_active":true,"is_bundle":true,"is_digital":true},"weight":{"unit":"string","value":0.1}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventories.ProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventories.ProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventories.ProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventories.ProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}}}},"500":{"description":"Internal Server Error"},"503":{"description":"Service Unavailable"}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Inventory"]}},"/2.0/inventory-level":{"get":{"summary":"  Get All Inventory Levels\n","parameters":[{"name":"SearchBy","in":"query","description":"","schema":{"$ref":"#/components/schemas/Inventories.Get.Api.V3.Inventory.Levels.SearchBy.String"},"examples":{"default":{"summary":"","description":"","value":"string"}}},{"name":"InventoryIds","in":"query","description":"","schema":{"$ref":"#/components/schemas/Inventories.Get.Api.V3.Inventory.Levels.InventoryIds.IntegerArray"},"examples":{"default":{"summary":"","description":"","value":[0]}}},{"name":"IsActive","in":"query","description":"","schema":{"$ref":"#/components/schemas/Inventories.Get.Api.V3.Inventory.Levels.IsActive.Boolean"},"examples":{"default":{"summary":"","description":"","value":"True"}}},{"name":"IsDigital","in":"query","description":"","schema":{"$ref":"#/components/schemas/Inventories.Get.Api.V3.Inventory.Levels.IsDigital.Boolean"},"examples":{"default":{"summary":"","description":"","value":"True"}}},{"name":"PageSize","in":"query","description":"","schema":{"$ref":"#/components/schemas/Inventories.Get.Api.V3.Inventory.Levels.PageSize.Integer"}},{"name":"SortBy","in":"query","description":"","schema":{"$ref":"#/components/schemas/Inventories.Get.Api.V3.Inventory.Levels.SortBy.String"},"examples":{"default":{"summary":"","description":"","value":"string"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventories.InventoryQuantityResponsePagedResponse"},"examples":{"default":{"summary":"","description":"","value":{"first":"string","items":[{"inventory_id":0,"name":"string","sku":"string","total_awaiting_quantity":0,"total_backordered_quantity":0,"total_committed_quantity":0,"total_exception_quantity":0,"total_fulfillable_quantity":0,"total_internal_transfer_quantity":0,"total_on_hand_quantity":0,"total_sellable_quantity":0}],"last":"string","next":"string","prev":"string"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventories.ProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventories.ProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventories.ProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}}}},"500":{"description":"Internal Server Error"},"503":{"description":"Service Unavailable"}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Inventory"]}},"/2.0/inventory-level/{inventoryId}/lots":{"get":{"summary":"  Get Inventory Levels Grouped By Lot\n","parameters":[{"name":"inventoryId","in":"path","description":"","required":true,"schema":{"$ref":"#/components/schemas/Inventories.Get.Api.V3.Inventory.Levels.InventoryId.Lots.InventoryId.Integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventories.InventoryQuantityLotResponse"},"examples":{"default":{"summary":"","description":"","value":{"inventory_id":0,"lots":[{"awaiting_quantity":0,"committed_quantity":0,"fulfillable_quantity":0,"internal_transfer_quantity":0,"locations":[{"awaiting_quantity":0,"committed_quantity":0,"fulfillable_quantity":0,"internal_transfer_quantity":0,"location_id":0,"name":"string","on_hand_quantity":0}],"lot_date":"2019-08-24T14:15:22+00:00","lot_number":"string","on_hand_quantity":0}],"name":"string","sku":"string"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventories.ProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventories.ProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventories.ProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventories.ProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}}}},"500":{"description":"Internal Server Error"},"503":{"description":"Service Unavailable"}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Inventory"]}},"/2.0/inventory-level/{inventoryId}":{"get":{"summary":"  Get Inventory Levels\n","parameters":[{"name":"inventoryId","in":"path","description":"","required":true,"schema":{"$ref":"#/components/schemas/Inventories.Get.Api.V3.Inventory.Levels.InventoryId.InventoryId.Integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventories.InventoryQuantityResponse"},"examples":{"default":{"summary":"","description":"","value":{"inventory_id":0,"name":"string","sku":"string","total_awaiting_quantity":0,"total_backordered_quantity":0,"total_committed_quantity":0,"total_exception_quantity":0,"total_fulfillable_quantity":0,"total_internal_transfer_quantity":0,"total_on_hand_quantity":0,"total_sellable_quantity":0}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventories.ProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventories.ProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventories.ProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventories.ProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}}}},"500":{"description":"Internal Server Error"},"503":{"description":"Service Unavailable"}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Inventory"]}},"/2.0/inventory-level/lots":{"get":{"summary":"  Get All Inventory Levels Grouped By Lot\n","parameters":[{"name":"LocationId","in":"query","description":"","schema":{"$ref":"#/components/schemas/Inventories.Get.Api.V3.Inventory.Levels.Lots.LocationId.Integer"}},{"name":"SearchBy","in":"query","description":"","schema":{"$ref":"#/components/schemas/Inventories.Get.Api.V3.Inventory.Levels.Lots.SearchBy.String"},"examples":{"default":{"summary":"","description":"","value":"string"}}},{"name":"InventoryIds","in":"query","description":"","schema":{"$ref":"#/components/schemas/Inventories.Get.Api.V3.Inventory.Levels.Lots.InventoryIds.IntegerArray"},"examples":{"default":{"summary":"","description":"","value":[0]}}},{"name":"IsActive","in":"query","description":"","schema":{"$ref":"#/components/schemas/Inventories.Get.Api.V3.Inventory.Levels.Lots.IsActive.Boolean"},"examples":{"default":{"summary":"","description":"","value":"True"}}},{"name":"IsDigital","in":"query","description":"","schema":{"$ref":"#/components/schemas/Inventories.Get.Api.V3.Inventory.Levels.Lots.IsDigital.Boolean"},"examples":{"default":{"summary":"","description":"","value":"True"}}},{"name":"PageSize","in":"query","description":"","schema":{"$ref":"#/components/schemas/Inventories.Get.Api.V3.Inventory.Levels.Lots.PageSize.Integer"}},{"name":"SortBy","in":"query","description":"","schema":{"$ref":"#/components/schemas/Inventories.Get.Api.V3.Inventory.Levels.Lots.SortBy.String"},"examples":{"default":{"summary":"","description":"","value":"string"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventories.InventoryQuantityLotResponsePagedResponse"},"examples":{"default":{"summary":"","description":"","value":{"first":"string","items":[{"inventory_id":0,"lots":[{"awaiting_quantity":0,"committed_quantity":0,"fulfillable_quantity":0,"internal_transfer_quantity":0,"locations":[{"awaiting_quantity":0,"committed_quantity":0,"fulfillable_quantity":0,"internal_transfer_quantity":0,"location_id":0,"name":"string","on_hand_quantity":0}],"lot_date":"2019-08-24T14:15:22+00:00","lot_number":"string","on_hand_quantity":0}],"name":"string","sku":"string"}],"last":"string","next":"string","prev":"string"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventories.ProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventories.ProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventories.ProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}}}},"500":{"description":"Internal Server Error"},"503":{"description":"Service Unavailable"}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Inventory"]}},"/2.0/inventory-level/{inventoryId}/locations":{"get":{"summary":"  Get Inventory Levels Grouped By Fulfillment Center\n","parameters":[{"name":"inventoryId","in":"path","description":"","required":true,"schema":{"$ref":"#/components/schemas/Inventories.Get.Api.V3.Inventory.Levels.InventoryId.Locations.InventoryId.Integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventories.InventoryQuantityFcResponse"},"examples":{"default":{"summary":"","description":"","value":{"inventory_id":0,"locations":[{"awaiting_quantity":0,"committed_quantity":0,"fulfillable_quantity":0,"internal_transfer_quantity":0,"location_id":0,"name":"string","on_hand_quantity":0}],"name":"string","sku":"string"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventories.ProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventories.ProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventories.ProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventories.ProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}}}},"500":{"description":"Internal Server Error"},"503":{"description":"Service Unavailable"}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Inventory"]}}},"components":{"schemas":{"Channels.ChannelArrayViewModel":{"type":"array","items":{"$ref":"#/components/schemas/Channels.ChannelViewModel"},"additionalProperties":false},"Channels.ChannelViewModel":{"type":"object","properties":{"application_name":{"type":"string","description":"Name of the application that owns the channel","example":"Api"},"id":{"type":"integer","description":"Unique id of the channel","format":"int32"},"name":{"type":"string","description":"Name of the channel"},"scopes":{"type":"array","items":{"type":"string"},"description":"Array of permissions granted for the channel","example":["channels_read","orders_read","orders_write"]}},"additionalProperties":false},"Channels.CreateChannelRequestModel":{"required":["name"],"type":"object","properties":{"name":{"minLength":1,"type":"string","description":"Name of the channel"}},"additionalProperties":false,"description":"Model for create channel request"},"Channels.ErrorResponse":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Events.ApiFeaturesEventsGetEvent":{"type":"object","properties":{"event_name":{"type":"string"},"event_offset":{"type":"string"},"event_timestamp":{"type":"string","format":"date-time"},"insert_timestamp":{"type":"string","format":"date-time"},"order_id":{"type":"string"},"payload":{"$ref":"#/components/schemas/Events.ApiFeaturesEventsGetPayload"},"sub_event_name":{"type":"string"},"user_id":{"type":"integer","format":"int32"}},"additionalProperties":false},"Events.ApiFeaturesEventsGetGetEventsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Events.ApiFeaturesEventsGetEvent"}},"next_page":{"type":"string"},"record_count":{"type":"integer","format":"int32"}},"additionalProperties":false},"Events.ApiFeaturesEventsGetPayload":{"type":"object","properties":{"address_1":{"type":"string"},"address_2":{"type":"string"},"carrier":{"type":"string"},"city":{"type":"string"},"company":{"type":"string"},"country":{"type":"string"},"email":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"phone":{"type":"string"},"state":{"type":"string"},"store_order_id":{"type":"string"},"sub_status_description":{"type":"string"},"tracking":{"type":"string"},"zip":{"type":"string"}},"additionalProperties":false},"Events.ApiFeaturesRegistrationRegisterRegisterActionResult":{"enum":[0,1,2],"type":"integer","description":"","x-enumNames":["RegistrationSuccessful","RegistrationExists","RegistrationFailed"]},"Events.ApiFeaturesRegistrationRegisterRegisterRequest":{"type":"object","properties":{"user_id":{"type":"integer","format":"int32"}},"additionalProperties":false,"example":{"user_id":12345}},"Events.ApiFeaturesRegistrationRegisterRegisterResponse":{"type":"object","properties":{"registration_result":{"$ref":"#/components/schemas/Events.ApiFeaturesRegistrationRegisterRegisterActionResult"},"registration_result_reason":{"type":"string"}},"additionalProperties":false},"Events.Get.Api.V1.Event.EndDate.String":{"type":"string","format":"date-time"},"Events.Get.Api.V1.Event.Offset.String":{"type":"string"},"Events.Get.Api.V1.Event.RecordsPerPage.Integer":{"type":"integer","format":"int32"},"Events.Get.Api.V1.Event.StartDate.String":{"type":"string","format":"date-time"},"Events.Post.Api.V1.Register.Unprocessable.Entity.String":{"type":"string"},"Inventories.DimensionsResponse":{"type":"object","properties":{"height":{"type":"number","format":"double"},"is_locked":{"type":"boolean"},"length":{"type":"number","format":"double"},"unit":{"type":"string"},"validated":{"type":"boolean"},"width":{"type":"number","format":"double"}},"additionalProperties":false},"Inventories.FilterOperation":{"type":"object","properties":{"key":{"type":"string"},"rawValue":{"type":"string"}},"additionalProperties":false},"Inventories.FilterOperationArray":{"type":"array","items":{"$ref":"#/components/schemas/Inventories.FilterOperation"}},"Inventories.FulfillableQuantityByFulfillmentCenter":{"type":"object","properties":{"awaiting_quantity":{"type":"integer","format":"int32"},"committed_quantity":{"type":"integer","format":"int32"},"fulfillable_quantity":{"type":"integer","format":"int32"},"internal_transfer_quantity":{"type":"integer","format":"int32"},"location_id":{"type":"integer","format":"int32"},"name":{"type":"string"},"on_hand_quantity":{"type":"integer","format":"int32"}},"additionalProperties":false},"Inventories.FulfillmentCenterResponse":{"type":"object","properties":{"awaiting_quantity":{"type":"integer","format":"int32"},"committed_quantity":{"type":"integer","format":"int32"},"fulfillable_quantity":{"type":"integer","format":"int32"},"internal_transfer_quantity":{"type":"integer","format":"int32"},"location_id":{"type":"integer","format":"int32"},"name":{"type":"string"},"on_hand_quantity":{"type":"integer","format":"int32"}},"additionalProperties":false},"Inventories.Get.Api.V3.Inventories.InventoryId.InventoryId.Integer":{"type":"integer","format":"int32"},"Inventories.Get.Api.V3.Inventories.InventoryIds.IntegerArray":{"type":"array","items":{"type":"integer","format":"int32"}},"Inventories.Get.Api.V3.Inventories.IsActive.Boolean":{"type":"boolean"},"Inventories.Get.Api.V3.Inventories.IsDigital.Boolean":{"type":"boolean"},"Inventories.Get.Api.V3.Inventories.PageSize.Integer":{"type":"integer","format":"int32"},"Inventories.Get.Api.V3.Inventories.SearchBy.String":{"type":"string"},"Inventories.Get.Api.V3.Inventories.SortBy.String":{"type":"string"},"Inventories.Get.Api.V3.Inventory.Levels.InventoryId.InventoryId.Integer":{"type":"integer","format":"int32"},"Inventories.Get.Api.V3.Inventory.Levels.InventoryId.Locations.InventoryId.Integer":{"type":"integer","format":"int32"},"Inventories.Get.Api.V3.Inventory.Levels.InventoryId.Lots.InventoryId.Integer":{"type":"integer","format":"int32"},"Inventories.Get.Api.V3.Inventory.Levels.InventoryIds.IntegerArray":{"type":"array","items":{"type":"integer","format":"int32"}},"Inventories.Get.Api.V3.Inventory.Levels.IsActive.Boolean":{"type":"boolean"},"Inventories.Get.Api.V3.Inventory.Levels.IsDigital.Boolean":{"type":"boolean"},"Inventories.Get.Api.V3.Inventory.Levels.Locations.InventoryIds.IntegerArray":{"type":"array","items":{"type":"integer","format":"int32"}},"Inventories.Get.Api.V3.Inventory.Levels.Locations.IsActive.Boolean":{"type":"boolean"},"Inventories.Get.Api.V3.Inventory.Levels.Locations.IsDigital.Boolean":{"type":"boolean"},"Inventories.Get.Api.V3.Inventory.Levels.Locations.LocationId.Integer":{"type":"integer","format":"int32"},"Inventories.Get.Api.V3.Inventory.Levels.Locations.LocationType.String":{"type":"string"},"Inventories.Get.Api.V3.Inventory.Levels.Locations.PageSize.Integer":{"type":"integer","format":"int32"},"Inventories.Get.Api.V3.Inventory.Levels.Locations.SearchBy.String":{"type":"string"},"Inventories.Get.Api.V3.Inventory.Levels.Locations.SortBy.String":{"type":"string"},"Inventories.Get.Api.V3.Inventory.Levels.Lots.InventoryIds.IntegerArray":{"type":"array","items":{"type":"integer","format":"int32"}},"Inventories.Get.Api.V3.Inventory.Levels.Lots.IsActive.Boolean":{"type":"boolean"},"Inventories.Get.Api.V3.Inventory.Levels.Lots.IsDigital.Boolean":{"type":"boolean"},"Inventories.Get.Api.V3.Inventory.Levels.Lots.LocationId.Integer":{"type":"integer","format":"int32"},"Inventories.Get.Api.V3.Inventory.Levels.Lots.PageSize.Integer":{"type":"integer","format":"int32"},"Inventories.Get.Api.V3.Inventory.Levels.Lots.SearchBy.String":{"type":"string"},"Inventories.Get.Api.V3.Inventory.Levels.Lots.SortBy.String":{"type":"string"},"Inventories.Get.Api.V3.Inventory.Levels.PageSize.Integer":{"type":"integer","format":"int32"},"Inventories.Get.Api.V3.Inventory.Levels.SearchBy.String":{"type":"string"},"Inventories.Get.Api.V3.Inventory.Levels.SortBy.String":{"type":"string"},"Inventories.HazmatResponse":{"type":"object","properties":{"is_hazmat":{"type":"boolean"},"validated":{"type":"boolean"}},"additionalProperties":false},"Inventories.InventoryQuantityFcResponse":{"type":"object","properties":{"inventory_id":{"type":"integer","format":"int32"},"locations":{"type":"array","items":{"$ref":"#/components/schemas/Inventories.FulfillmentCenterResponse"}},"name":{"type":"string"},"sku":{"type":"string"}},"additionalProperties":false},"Inventories.InventoryQuantityFcResponsePagedResponse":{"type":"object","properties":{"first":{"type":"string"},"items":{"type":"array","items":{"$ref":"#/components/schemas/Inventories.InventoryQuantityFcResponse"}},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}},"additionalProperties":false},"Inventories.InventoryQuantityLotResponse":{"type":"object","properties":{"inventory_id":{"type":"integer","format":"int32"},"lots":{"type":"array","items":{"$ref":"#/components/schemas/Inventories.Lots"}},"name":{"type":"string"},"sku":{"type":"string"}},"additionalProperties":false},"Inventories.InventoryQuantityLotResponsePagedResponse":{"type":"object","properties":{"first":{"type":"string"},"items":{"type":"array","items":{"$ref":"#/components/schemas/Inventories.InventoryQuantityLotResponse"}},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}},"additionalProperties":false},"Inventories.InventoryQuantityResponse":{"type":"object","properties":{"inventory_id":{"type":"integer","format":"int32"},"name":{"type":"string"},"sku":{"type":"string"},"total_awaiting_quantity":{"type":"integer","format":"int32"},"total_backordered_quantity":{"type":"integer","format":"int32"},"total_committed_quantity":{"type":"integer","format":"int32"},"total_exception_quantity":{"type":"integer","format":"int32"},"total_fulfillable_quantity":{"type":"integer","format":"int32"},"total_internal_transfer_quantity":{"type":"integer","format":"int32"},"total_on_hand_quantity":{"type":"integer","format":"int32"},"total_sellable_quantity":{"type":"integer","format":"int32"}},"additionalProperties":false},"Inventories.InventoryQuantityResponsePagedResponse":{"type":"object","properties":{"first":{"type":"string"},"items":{"type":"array","items":{"$ref":"#/components/schemas/Inventories.InventoryQuantityResponse"}},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}},"additionalProperties":false},"Inventories.InventoryResponse":{"type":"object","properties":{"barcode":{"type":"string"},"dimensions":{"$ref":"#/components/schemas/Inventories.DimensionsResponse"},"inventory_id":{"type":"integer","format":"int32"},"is_case":{"type":"boolean"},"is_lot":{"type":"boolean"},"name":{"type":"string"},"sku":{"type":"string"},"user_id":{"type":"integer","format":"int32"},"variant":{"$ref":"#/components/schemas/Inventories.VariantResponse"},"weight":{"$ref":"#/components/schemas/Inventories.WeightResponse"}},"additionalProperties":false},"Inventories.InventoryResponsePagedResponse":{"type":"object","properties":{"first":{"type":"string"},"items":{"type":"array","items":{"$ref":"#/components/schemas/Inventories.InventoryResponse"}},"last":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}},"additionalProperties":false},"Inventories.Lots":{"type":"object","properties":{"awaiting_quantity":{"type":"integer","format":"int32"},"committed_quantity":{"type":"integer","format":"int32"},"fulfillable_quantity":{"type":"integer","format":"int32"},"internal_transfer_quantity":{"type":"integer","format":"int32"},"locations":{"type":"array","items":{"$ref":"#/components/schemas/Inventories.FulfillableQuantityByFulfillmentCenter"}},"lot_date":{"type":"string","format":"date-time"},"lot_number":{"type":"string"},"on_hand_quantity":{"type":"integer","format":"int32"}},"additionalProperties":false},"Inventories.ProblemDetails":{"type":"object","properties":{"detail":{"type":"string"},"instance":{"type":"string"},"status":{"type":"integer","format":"int32"},"title":{"type":"string"},"type":{"type":"string"}},"additionalProperties":{}},"Inventories.VariantResponse":{"type":"object","properties":{"hazmat":{"$ref":"#/components/schemas/Inventories.HazmatResponse"},"is_active":{"type":"boolean"},"is_bundle":{"type":"boolean"},"is_digital":{"type":"boolean"}},"additionalProperties":false},"Inventories.WeightResponse":{"type":"object","properties":{"unit":{"type":"string"},"value":{"type":"number","format":"double"}},"additionalProperties":false},"Inventory.DimensionViewModel":{"type":"object","properties":{"depth":{"type":"number","description":"Depth in inches of this inventory item","format":"double"},"length":{"type":"number","description":"Length in inches of this inventory item","format":"double"},"weight":{"type":"number","description":"Weight in ounces of this inventory item","format":"double"},"width":{"type":"number","description":"Width in inches of this inventory item","format":"double"}},"additionalProperties":false,"description":"Information about an inventory item's dimensions"},"Inventory.EventCategory":{"enum":["OrderPicking","SpotChecking","SkuChange","Receiving","RestockAfterPicking","RestockAfterReturn"],"type":"string"},"Inventory.FulfillmentCenterQuantityViewModel":{"type":"object","properties":{"awaiting_quantity":{"type":"integer","description":"Amount of quantity awaiting arrival of a receiving order at this fulfillment center","format":"int32"},"committed_quantity":{"type":"integer","description":"Amount of committed quantity at this fulfillment center","format":"int32"},"fulfillable_quantity":{"type":"integer","description":"Amount of fulfillable quantity at this fulfillment center","format":"int32"},"id":{"type":"integer","description":"Unique id of the fulfillment center","format":"int32"},"internal_transfer_quantity":{"type":"integer","description":"The quantity of items that are in the process of internal transit \r\nbetween ShipBob fulfillment centers, with a destination of this fulfillment center.\r\nThese items are not pickable or fulfillable until they have been received and moved \r\nto the \"On Hand\" quantity of the destination FC.","format":"int32"},"name":{"type":"string","description":"Name of the fulfillment center","example":"Cicero"},"onhand_quantity":{"type":"integer","description":"Amount of onhand quantity at this fulfillment center","format":"int32"}},"additionalProperties":false,"description":"Break down of fulfillable quantity by fulfillment center"},"Inventory.Get.Api.Inventory.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Inventory.Get.Api.Inventory.History.Query.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Inventory.Get.Api.Inventory.History.Query.EndDate.String":{"type":"string","format":"date-time"},"Inventory.Get.Api.Inventory.History.Query.FulfillmentCenterId.Integer":{"type":"integer","format":"int32"},"Inventory.Get.Api.Inventory.History.Query.InventoryIds.IntegerArray":{"type":"array","items":{"type":"integer","format":"int32"}},"Inventory.Get.Api.Inventory.History.Query.Limit.Integer":{"maximum":2000,"minimum":1,"type":"integer","format":"int32"},"Inventory.Get.Api.Inventory.History.Query.Page.Integer":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32"},"Inventory.Get.Api.Inventory.History.Query.StartDate.String":{"type":"string","format":"date-time"},"Inventory.Get.Api.Inventory.IDs.IntegerArray":{"type":"array","items":{"type":"integer","format":"int32"}},"Inventory.Get.Api.Inventory.InventoryId.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Inventory.Get.Api.Inventory.InventoryId.History.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Inventory.Get.Api.Inventory.InventoryId.History.EndDate.String":{"type":"string","format":"date-time"},"Inventory.Get.Api.Inventory.InventoryId.History.FulfillmentCenterId.Integer":{"type":"integer","format":"int32"},"Inventory.Get.Api.Inventory.InventoryId.History.InventoryId.Integer":{"type":"integer","format":"int32"},"Inventory.Get.Api.Inventory.InventoryId.History.Limit.Integer":{"maximum":2000,"minimum":1,"type":"integer","format":"int32"},"Inventory.Get.Api.Inventory.InventoryId.History.Page.Integer":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32"},"Inventory.Get.Api.Inventory.InventoryId.History.StartDate.String":{"type":"string","format":"date-time"},"Inventory.Get.Api.Inventory.InventoryId.InventoryId.Integer":{"type":"integer","format":"int32"},"Inventory.Get.Api.Inventory.IsActive.Boolea":{"type":"boolean"},"Inventory.Get.Api.Inventory.IsActive.Boolean":{"type":"boolean"},"Inventory.Get.Api.Inventory.IsDigital.Boolea":{"type":"boolean"},"Inventory.Get.Api.Inventory.IsDigital.Boolean":{"type":"boolean"},"Inventory.Get.Api.Inventory.Limit.Integer":{"maximum":250,"minimum":1,"type":"integer","format":"int32"},"Inventory.Get.Api.Inventory.LocationType.String":{"type":"string"},"Inventory.Get.Api.Inventory.Page.Integer":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32"},"Inventory.Get.Api.Inventory.Search.String":{"type":"string"},"Inventory.Get.Api.Inventory.Sort.String":{"type":"string"},"Inventory.Get.Api.Product.ProductId.Inventory.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Inventory.Get.Api.Product.ProductId.Inventory.ProductId.Integer":{"type":"integer","format":"int32"},"Inventory.Get.Api.Product.ProductId.Inventory.Shipbob.Channel.Id.Integer":{"type":"integer","format":"int32"},"Inventory.InventoryHistoryViewModel":{"type":"object","properties":{"event_category":{"type":"string","description":"Event Category to filter by"},"event_date":{"type":"string","description":"Unique id of the order","format":"date-time"},"fulfillment_center_id":{"type":"integer","description":"Unique id of the order","format":"int32"},"inventory_id":{"type":"integer","description":"Inventory Id","format":"int32"},"inventory_quantity_changed":{"type":"integer","description":"Unique id of the order","format":"int32"}},"additionalProperties":false},"Inventory.InventoryHistoryViewModelArray":{"type":"array","items":{"$ref":"#/components/schemas/Inventory.InventoryHistoryViewModel"}},"Inventory.InventoryViewModel":{"type":"object","properties":{"dimensions":{"$ref":"#/components/schemas/Inventory.DimensionViewModel"},"fulfillable_quantity_by_fulfillment_center":{"type":"array","items":{"$ref":"#/components/schemas/Inventory.FulfillmentCenterQuantityViewModel"},"description":"Fulfillable quantity of this inventory item broken down by fulfillment center location"},"fulfillable_quantity_by_lot":{"type":"array","items":{"$ref":"#/components/schemas/Inventory.LotQuantityViewModel"},"description":"Fulfillable quantity of this inventory item broken down by lot"},"id":{"type":"integer","description":"Unique id of the inventory item","format":"int32"},"is_active":{"type":"boolean","description":"Whether the inventory is active or not"},"is_case_pick":{"type":"boolean","description":"True if the inventory item is marked as case pick"},"is_digital":{"type":"boolean","description":"True if the inventory item is marked as a digital item"},"is_lot":{"type":"boolean","description":"True if this inventory item is organized into lots"},"name":{"type":"string","description":"Name of the inventory item","example":"Medium Blue T-Shirt"},"packaging_attribute":{"$ref":"#/components/schemas/Inventory.PackagingAttribute"},"total_awaiting_quantity":{"type":"integer","description":"Total quantity in unreceived receiving orders for this inventory item","format":"int32"},"total_backordered_quantity":{"type":"integer","description":"The amount of the item you need to send to ShipBob to fulfill all exception orders containing \r\nthe item. This is the exception_quantity less the fulfillable_quantity of the item.","format":"int32"},"total_committed_quantity":{"type":"integer","description":"Total committed quantity of this inventory item","format":"int32"},"total_exception_quantity":{"type":"integer","description":"The total quantity of all items that are contained within orders that\r\nare in exception/out of stock status. Out of stock orders have not been\r\nprocessed and therefore do not have lot or fulfillment centers assigned.","format":"int32"},"total_fulfillable_quantity":{"type":"integer","description":"Total fulfillable quantity of this inventory item","format":"int32"},"total_internal_transfer_quantity":{"type":"integer","description":"The total quantity of all items that are in the process of internal transit \r\nbetween ShipBob fulfillment centers. These items are not pickable or fulfillable\r\nuntil they have been received and moved to the \"On Hand\" quantity of the destination FC.\r\nInternal transit quantities for each FC represent the incoming transfer stock\r\nfor that specific location.","format":"int32"},"total_onhand_quantity":{"type":"integer","description":"Total onhand quantity of this inventory item","format":"int32"},"total_sellable_quantity":{"type":"integer","description":"Total quantity that can be sold without overselling the inventory item.\r\nThis is calculated by subtracting the total exception quantity from the\r\nfulfillable quantity.","format":"int32"}},"additionalProperties":false,"description":"Information about an inventory item"},"Inventory.InventoryViewModelArray":{"type":"array","items":{"$ref":"#/components/schemas/Inventory.InventoryViewModel"}},"Inventory.LotQuantityViewModel":{"type":"object","properties":{"awaiting_quantity":{"type":"integer","description":"Quantity of inventory items belonging to this lot awaiting arrival of a receiving order","format":"int32"},"committed_quantity":{"type":"integer","description":"Committed quantity of inventory items belonging to this lot","format":"int32"},"expiration_date":{"type":"string","description":"Expiration date for this lot","format":"date-time"},"fulfillable_quantity":{"type":"integer","description":"Fulfillable quantity of inventory items belonging to this lot","format":"int32"},"fulfillable_quantity_by_fulfillment_center":{"type":"array","items":{"$ref":"#/components/schemas/Inventory.FulfillmentCenterQuantityViewModel"},"description":"Fulfillable quantity of inventory items belonging to this lot broken down by fulfillment center location"},"internal_transfer_quantity":{"type":"integer","description":"The quantity of all items belonging to this lot that are in the process of internal transit \r\nbetween ShipBob fulfillment centers. These items are not pickable or fulfillable\r\nuntil they have been received and moved to the \"On Hand\" quantity of the destination FC.\r\nInternal transit quantities for each FC represent the incoming transfer stock\r\nfor that specific location.","format":"int32"},"lot_number":{"type":"string","description":"Identification number of this lot","example":"1234"},"onhand_quantity":{"type":"integer","description":"OnHand quantity of inventory items belonging to this lot","format":"int32"}},"additionalProperties":false,"description":"Break down of fulfillable quantity by lot"},"Inventory.PackagingAttribute":{"enum":["None","Fragile","Foldable","Stackable","Book","CustomPackaging","CustomDunnage","MarketingInsert","Poster"],"type":"integer","format":"int32"},"Inventory.ProblemDetail":{"type":"object","properties":{"detail":{"type":"string"},"instance":{"type":"string"},"status":{"type":"integer","format":"int32"},"title":{"type":"string"},"type":{"type":"string"}},"additionalProperties":{}},"Inventory.ProblemDetails":{"type":"object","properties":{"detail":{"type":"string"},"instance":{"type":"string"},"status":{"type":"integer","format":"int32"},"title":{"type":"string"},"type":{"type":"string"}},"additionalProperties":{}},"Inventory.SortOrder":{"enum":["Newest","Oldest"],"type":"string","description":"Specify if you want to sort by newest first or oldest first"},"Locations.AddressViewModel":{"type":"object","properties":{"address1":{"type":"string","description":"First part of the address of the location for this service"},"address2":{"type":"string","description":"Second part of the address of the location for this service"},"city":{"type":"string","description":"City of the location"},"country":{"type":"string","description":"Country of the location"},"email":{"type":"string","description":"Email of the location for this service"},"name":{"type":"string","description":"Name to use in the address of the location for this service"},"phone_number":{"type":"string","description":"Phone Number of the location for this service"},"state":{"type":"string","description":"State of the location"},"zip_code":{"type":"string","description":"Zip code of the location"}},"additionalProperties":false,"description":"The service-specific address of the location. Each object contains address type, address1, address2, city, state, country, zip code, phone number, and email"},"Locations.FcAttributeViewModel":{"type":"object","properties":{"id":{"type":"integer","description":"Unique Id for the fulfillment center attribute","format":"int32"},"name":{"type":"string","description":"Name of the attribute."}},"additionalProperties":false},"Locations.FcTypeViewModel":{"type":"object","properties":{"id":{"type":"integer","description":"Unique Id for the fulfillment center type","format":"int32"},"name":{"type":"string","description":"Name of the fc type"}},"additionalProperties":false},"Locations.FcTypeViewModelV2":{"type":"object","allOf":[{"$ref":"#/components/schemas/Locations.FcTypeViewModel"}],"properties":{"organization_roles":{"type":"array","items":{"$ref":"#/components/schemas/Locations.OrganizationRoleViewModel"}},"organization_type_id":{"type":"string","format":"uuid"},"organization_type_name":{"type":"string"}},"additionalProperties":false},"Locations.FulfillmentCenterRegionViewModel":{"type":"object","properties":{"id":{"type":"integer","description":"Unique Id for the location region","format":"int32"},"name":{"type":"string","description":"Name of the region the location is in."}},"additionalProperties":false},"Locations.Get.1.0.Location.AccessGranted.Boolea":{"type":"boolean","description":"Return all the access granted locations"},"Locations.Get.1.0.Location.AccessGranted.Boolean":{"type":"boolean","description":"Return all the access granted locations"},"Locations.Get.1.0.Location.IncludeInactive.Boolea":{"type":"boolean","description":"Whether the inactive locations should be included or not"},"Locations.Get.1.0.Location.IncludeInactive.Boolean":{"type":"boolean","description":"Whether the inactive locations should be included or not"},"Locations.Get.1.0.Location.OK.OneOfArray":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Locations.LocationViewModel"},{"$ref":"#/components/schemas/Locations.InternalLocationViewModel"},{"$ref":"#/components/schemas/Locations.InternalLocationViewModelV2"},{"$ref":"#/components/schemas/Locations.LocationViewModelV2"}]}},"Locations.Get.1.0.Location.ReceivingEnabled.Boolea":{"type":"boolean","description":"Return all the receiving enabled locations"},"Locations.Get.1.0.Location.ReceivingEnabled.Boolean":{"type":"boolean","description":"Return all the receiving enabled locations"},"Locations.InternalLocationViewModel":{"type":"object","allOf":[{"$ref":"#/components/schemas/Locations.LocationViewModel"}],"properties":{"fulfillment_center_attributes":{"type":"array","items":{"$ref":"#/components/schemas/Locations.FcAttributeViewModel"}},"fulfillment_center_type":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Locations.FcTypeViewModel"},{"$ref":"#/components/schemas/Locations.FcTypeViewModelV2"}]},"is_enabled_for_new_user":{"type":"boolean"},"is_external":{"type":"boolean"}},"additionalProperties":false},"Locations.InternalLocationViewModelV2":{"type":"object","allOf":[{"$ref":"#/components/schemas/Locations.LocationViewModelV2"}],"properties":{"fulfillment_center_attributes":{"type":"array","items":{"$ref":"#/components/schemas/Locations.FcAttributeViewModel"}},"fulfillment_center_type":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Locations.FcTypeViewModel"},{"$ref":"#/components/schemas/Locations.FcTypeViewModelV2"}]},"is_enabled_for_new_user":{"type":"boolean"},"sort_center":{"$ref":"#/components/schemas/Locations.SortCenterViewModel"}},"additionalProperties":false},"Locations.LocationViewModel":{"type":"object","properties":{"abbreviation":{"type":"string","description":"Abbreviation of the location. Combination of nearest Airport Code and the sequence number."},"access_granted":{"type":"boolean","description":"Indicates whether or not the user is authorized to interact at all with the location"},"attributes":{"type":"array","items":{"type":"string"},"description":"Available attributes for the location"},"id":{"type":"integer","description":"Id of the location in ShipBob’s database","format":"int32"},"is_active":{"type":"boolean","description":"Indicates if the location is operationally active or inactive"},"is_receiving_enabled":{"type":"boolean","description":"Indicates if the receiving is enabled for FC"},"is_shipping_enabled":{"type":"boolean","description":"Indicates if the shipping is enabled for FC"},"name":{"type":"string","description":"Name of the location. Follows the naming convention City (State Code)\r\nfor domestic FCs and City (Country Code) for international FCs"},"region":{"$ref":"#/components/schemas/Locations.FulfillmentCenterRegionViewModel"},"services":{"type":"array","items":{"$ref":"#/components/schemas/Locations.ServiceViewModel"},"description":"Services provided by the location"},"timezone":{"type":"string","description":"Time zone of the location"}},"additionalProperties":false},"Locations.LocationViewModelV2":{"type":"object","allOf":[{"$ref":"#/components/schemas/Locations.LocationViewModel"}],"properties":{"organization_id":{"type":"string","format":"uuid"},"owner_id":{"type":"string","format":"uuid"},"parent_id":{"type":"string","format":"uuid"}},"additionalProperties":false},"Locations.OrganizationRoleViewModel":{"type":"object","properties":{"description":{"type":"string"},"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"additionalProperties":false},"Locations.ServiceTypeEnum":{"enum":["Receiving","Returns"],"type":"string"},"Locations.ServiceViewModel":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/Locations.AddressViewModel"},"enabled":{"type":"boolean","description":"Indicates if the user is authorized to access this service at the location"},"service_type":{"$ref":"#/components/schemas/Locations.ServiceTypeEnum"}},"additionalProperties":false},"Locations.SortCenterViewModel":{"type":"object","properties":{"id":{"type":"integer","description":"Unique Id for the fulfillment center","format":"int32"}},"additionalProperties":false},"Metrics.OrderIngestionErrorLogRequest":{"required":["store_integration_id"],"type":"object","properties":{"error_time_stamp":{"type":"string","format":"date-time"},"error_type_id":{"type":"integer","format":"int32"},"is_order_ingested":{"type":"boolean"},"order_pull_type_id":{"type":"integer","format":"int32"},"platform_source":{"$ref":"#/components/schemas/Metrics.PlatformSourceEnum"},"retry_count":{"type":"integer","format":"int32"},"store_integration_id":{"type":"integer","format":"int32"},"store_name":{"maxLength":200,"type":"string"},"store_order_id":{"type":"string"},"store_reference_id":{"type":"string"},"user_id":{"type":"integer","format":"int32"}},"additionalProperties":false},"Metrics.PlatformSourceEnum":{"enum":[0,1,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,-1],"type":"integer","format":"int32"},"Metrics.ProblemDetail":{"type":"object","properties":{"detail":{"type":"string"},"instance":{"type":"string"},"status":{"type":"integer","format":"int32"},"title":{"type":"string"},"type":{"type":"string"}},"additionalProperties":{}},"Metrics.ProblemDetails":{"type":"object","properties":{"detail":{"type":"string"},"instance":{"type":"string"},"status":{"type":"integer","format":"int32"},"title":{"type":"string"},"type":{"type":"string"}},"additionalProperties":{}},"Metrics.SyncMetricsLogRequest":{"required":["is_success_metric","store_integration_id","sync_start_date_time","sync_type"],"type":"object","properties":{"error_time_stamp":{"type":"string","format":"date-time"},"error_type_id":{"type":"integer","format":"int32"},"is_success_metric":{"type":"boolean"},"order_id":{"type":"integer","format":"int32"},"order_status":{"maxLength":20,"type":"string"},"order_sub_status":{"maxLength":50,"type":"string"},"platform_source":{"$ref":"#/components/schemas/Metrics.PlatformSourceEnum"},"store_integration_id":{"type":"integer","format":"int32"},"store_name":{"maxLength":200,"type":"string"},"store_reference_id":{"maxLength":300,"type":"string"},"sync_count":{"type":"integer","format":"int32"},"sync_start_date_time":{"type":"string","format":"date-time"},"sync_type":{"type":"integer","format":"int32"},"user_id":{"type":"integer","format":"int32"}},"additionalProperties":false},"Metrics.SyncMetricsLogRequestArray":{"type":"array","items":{"$ref":"#/components/schemas/Metrics.SyncMetricsLogRequest"}},"Metrics.TrackingUploadErrorLogRequest":{"required":["store_integration_id"],"type":"object","properties":{"error_time_stamp":{"type":"string","format":"date-time"},"error_type_id":{"type":"integer","format":"int32"},"is_tracking_uploaded":{"type":"boolean"},"lineItemErrors":{"type":"array","items":{"$ref":"#/components/schemas/Metrics.TrackingUploadLineItemErrorLog"}},"order_id":{"type":"integer","format":"int32"},"platform_source":{"$ref":"#/components/schemas/Metrics.PlatformSourceEnum"},"store_integration_id":{"type":"integer","format":"int32"},"store_name":{"maxLength":200,"type":"string"},"user_id":{"type":"integer","format":"int32"}},"additionalProperties":false},"Metrics.TrackingUploadLineItemErrorLog":{"type":"object","properties":{"errorTypeId":{"type":"integer","format":"int32"},"isTrackingUploaded":{"type":"boolean"},"lineItemId":{"type":"string"},"sku":{"type":"string"},"timeStamp":{"type":"string","format":"date-time"}},"additionalProperties":false},"Orders.AddProductToOrderByProductIdModel":{"required":["productId","quantity"],"type":"object","allOf":[{"$ref":"#/components/schemas/Orders.AddProductToOrderModel"}],"properties":{"external_line_id":{"type":"integer","description":"Numeric assignment per item. Used as a reference number for multiple purposes such as split orders, split containers, etc.","format":"int32"},"id":{"type":"integer","description":"Unique id of the product","format":"int32"},"quantity":{"type":"integer","description":"The quantity of this product ordered","format":"int32"},"quantity_unit_of_measure_code":{"type":"string","description":"Defined standard for measure for an item (each, inner pack, case, pallet).  Values: EA, INP, CS and PL"}},"additionalProperties":false},"Orders.AddProductToOrderByReferenceIdModel":{"required":["quantity","referenceId"],"type":"object","allOf":[{"$ref":"#/components/schemas/Orders.AddProductToOrderModel"}],"properties":{"external_line_id":{"type":"integer","description":"Numeric assignment per item. Used as a reference number for multiple purposes such as split orders, split containers, etc.","format":"int32"},"gtin":{"maxLength":50,"minLength":0,"type":"string","description":"Global Trade Item Number - unique and internationally recognized identifier assigned to item by company GS1"},"name":{"type":"string","description":"Name of the product. Required if there is not an existing ShipBob product with a matching reference_id value.","example":"TShirtBlueM"},"quantity":{"type":"integer","description":"The quantity of this product ordered","format":"int32"},"quantity_unit_of_measure_code":{"type":"string","description":"Defined standard for measure for an item (each, inner pack, case, pallet).  Values: EA, INP, CS and PL"},"reference_id":{"minLength":1,"type":"string","description":"Unique reference id of the product","example":"TShirtBlueM"},"sku":{"type":"string","description":"Product SKU"},"unit_price":{"type":"number","description":"Price for one item","format":"double"},"upc":{"maxLength":50,"minLength":0,"type":"string","description":"Universal Product Code - Unique external identifier"}},"additionalProperties":false},"Orders.AddProductToOrderModel":{"type":"object","properties":{"external_line_id":{"type":"integer","description":"Numeric assignment per item. Used as a reference number for multiple purposes such as split orders, split containers, etc.","format":"int32"},"quantity":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"},"quantity_unit_of_measure_code":{"type":"string","description":"Defined standard for measure for an item (each, inner pack, case, pallet).  Values: EA, INP, CS and PL"}},"additionalProperties":false},"Orders.AddStoreOrderJsonModel":{"required":["orderJson"],"type":"object","properties":{"order_json":{"minLength":1,"type":"string","description":"Json String that represent the order on a store front system"}},"additionalProperties":false,"description":"Model for adding a Store Order Json to a ShipBob Order."},"Orders.AddressType":{"enum":["MarkFor","ShipFrom"],"type":"string"},"Orders.AddressViewModel":{"required":["address1","city","country"],"type":"object","properties":{"address1":{"minLength":1,"type":"string","description":"First line of the address","example":"100 Nowhere Blvd"},"address2":{"type":"string","description":"Second line of the address","example":"Suite 100"},"city":{"minLength":1,"type":"string","description":"The city","example":"Gotham City"},"company_name":{"type":"string","description":"Name of the company receiving the shipment","example":"Wayne Enterprises"},"country":{"minLength":1,"type":"string","description":"The country (Must be ISO Alpha-2 for estimates)","example":"US"},"state":{"type":"string","description":"The state or province","example":"NJ"},"zip_code":{"type":"string","description":"The zip code or postal code","format":"postal-code","example":"07093"}},"additionalProperties":false},"Orders.BulkUpdateResponseError":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"additionalProperties":false},"Orders.BulkUpdateResponseModel":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/Orders.BulkUpdateResponseResult"}},"summary":{"$ref":"#/components/schemas/Orders.BulkUpdateResponseSummary"}},"additionalProperties":false},"Orders.BulkUpdateResponseResult":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/Orders.BulkUpdateResponseError"},"isSuccess":{"type":"boolean"},"shipmentId":{"type":"integer","format":"int64"}},"additionalProperties":false},"Orders.BulkUpdateResponseSummary":{"type":"object","properties":{"failed":{"type":"integer","format":"int32"},"successful":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"}},"additionalProperties":false},"Orders.BulkUpdateTrackingUploadModel":{"type":"object","properties":{"is_tracking_uploaded":{"type":"boolean","description":"Indicates whether the Shipment was marked with tracking information\r\nuploaded to a third-party system where the order originated.\r\nApplies to all shipments in shipment_ids"},"shipment_ids":{"type":"array","items":{"type":"integer","format":"int32"},"description":"Shipment IDs to apply the tracking upload status to"}},"additionalProperties":false,"description":"Model for updating tracking upload status for multiple shipments"},"Orders.CancelShipmentsModel":{"type":"object","properties":{"shipment_ids":{"type":"array","items":{"type":"integer","format":"int32"},"description":"Shipment IDs to cancel"}},"additionalProperties":false,"description":"Model for cancel multiple shipments at once"},"Orders.CanceledOrderViewModel":{"type":"object","properties":{"canceled_shipment_results":{"type":"array","items":{"$ref":"#/components/schemas/Orders.CanceledShipmentViewModel"},"description":"Results of canceling the shipments associated with the order"},"order":{"$ref":"#/components/schemas/Orders.OrderViewModel"},"order_id":{"type":"integer","description":"The ID of the canceled order","format":"int32"},"status":{"$ref":"#/components/schemas/Orders.CancellationResult"}},"additionalProperties":false,"description":""},"Orders.CanceledShipmentViewModel":{"type":"object","properties":{"action":{"$ref":"#/components/schemas/Orders.ShipmentAction"},"is_success":{"type":"boolean","description":"If the cancel action was successful"},"reason":{"type":"string","description":"The reason the cancellation result"},"shipment_id":{"type":"integer","description":"The ID of the shipment","format":"int64"}},"additionalProperties":false,"description":""},"Orders.CanceledShipmentsViewModel":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/Orders.CanceledShipmentViewModel"},"description":"The results of all cancellation actions"}},"additionalProperties":false,"description":""},"Orders.CancellationResult":{"enum":["Success","Failure","PartialSuccess"],"type":"string"},"Orders.CarrierShipType":{"enum":["Parcel","Freight"],"type":"string"},"Orders.CartonDetailsViewModel":{"type":"object","properties":{"products":{"type":"array","items":{"$ref":"#/components/schemas/Orders.ShipmentProductViewModel"},"description":"List of what is packed in this carton"}},"additionalProperties":false},"Orders.CartonMeasurementsViewModel":{"type":"object","properties":{"depth_in":{"type":"number","description":"Total depth in inches","format":"double"},"length_in":{"type":"number","description":"Total length in inches","format":"double"},"total_weight_oz":{"type":"number","description":"Total weight in ounces","format":"double"},"width_in":{"type":"number","description":"Total width in inches","format":"double"}},"additionalProperties":false,"description":"Measurements of a carton"},"Orders.CartonViewModel":{"type":"object","properties":{"barcode":{"type":"string","description":"Barcode assigned to this carton"},"carton_details":{"type":"array","items":{"$ref":"#/components/schemas/Orders.CartonDetailsViewModel"},"description":"Details about the contents of this carton"},"id":{"type":"integer","description":"ID assigned to this carton","format":"int32"},"measurements":{"$ref":"#/components/schemas/Orders.CartonMeasurementsViewModel"},"type":{"type":"string","description":"Type of this carton container","example":"Box or pallet"}},"additionalProperties":false},"Orders.ChannelInfoViewModel":{"type":"object","properties":{"id":{"type":"integer","description":"Unique id of the channel","format":"int32"},"name":{"type":"string","description":"Name of the channel","example":"ShipBobs-Shopify-Store"}},"additionalProperties":false,"description":"Created by channel metadata"},"Orders.CreateOrderModel":{"required":["products","recipient","referenceId","shippingMethod"],"type":"object","properties":{"financials":{"$ref":"#/components/schemas/Orders.Financials"},"gift_message":{"maxLength":500,"type":"string","description":"Gift message associated with the order"},"location_id":{"type":"integer","description":"Desired Fulfillment Center Location ID. If not specified, ShipBob will determine the location that fulfills this order.","format":"int32"},"order_number":{"maxLength":400,"type":"string","description":"User friendly orderId or store order number that will be shown on the Orders Page. If not provided, referenceId will be used"},"origin_platform_program":{"maxLength":100,"type":"string","description":"Origin platform program for the order. Accepts a program name.","example":"FBM"},"products":{"minItems":1,"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Orders.AddProductToOrderByProductIdModel"},{"$ref":"#/components/schemas/Orders.AddProductToOrderByReferenceIdModel"}]},"description":"Products included in the order. Products identified by reference_id must also include the product name if there is no matching ShipBob product."},"purchase_date":{"type":"string","description":"Date this order was purchase by the end user","format":"date-time"},"recipient":{"$ref":"#/components/schemas/Orders.RecipientInfoViewModel"},"reference_id":{"maxLength":300,"minLength":1,"type":"string","description":"Unique and immutable order identifier from your upstream system"},"retailer_program_data":{"$ref":"#/components/schemas/Orders.RetailerProgramDataViewModel"},"sales_channel":{"maxLength":100,"type":"string","description":"Origin platform source for the order. Accepts a sales channel name that is case insensitive and the list of acceptable values can be found at https://support.shipbob.com/s/article/ShipBob-Developer-API","example":"Amazon"},"shipping_method":{"minLength":1,"type":"string","description":"Client-defined shipping method matching what the user has listed as the shipping method on the Ship Option Mapping setup page in the ShipBob Merchant Portal. If they don’t match, we will create a new one and default it to Standard","example":"Free 2-day Shipping"},"shipping_terms":{"$ref":"#/components/schemas/Orders.ShippingTermsViewModel"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/Orders.TagViewModel"},"description":"Key value pair array to store extra information at the order level for API purposes. ShipBob won't display the info in the ShipBob Merchant Portal or react based on this data."},"type":{"$ref":"#/components/schemas/Orders.OrderType"}},"additionalProperties":false},"Orders.EstimateDetailViewModel":{"type":"object","properties":{"estimated_currency_code":{"type":"string","description":"Estimated local currency code"},"estimated_price":{"type":"number","description":"Estimated price in dollars for the provided shipping method","format":"double"},"fulfillment_center":{"$ref":"#/components/schemas/Orders.FulfillmentCenterViewModel"},"shipping_method":{"type":"string","description":"Provided shipping method. Maps to ship option in ShipBob."},"total_weight_oz":{"type":"number","description":"Total weight of items in cart including packaging.","format":"double"}},"additionalProperties":false},"Orders.EstimateFulfillmentRequestModel":{"required":["address","products"],"type":"object","properties":{"address":{"$ref":"#/components/schemas/Orders.EstimationAddressViewModel"},"products":{"type":"array","items":{"$ref":"#/components/schemas/Orders.EstimateProductInfoModel"},"description":"Products to be included in the order. Each product must include one of reference_id or id"},"shipping_methods":{"type":"array","items":{"type":"string"},"description":"Array of strings specifying shipping methods for which to fetch estimates.\r\n\r\nIf this field is omitted we will return estimates for all shipping methods defined in ShipBob"}},"additionalProperties":false},"Orders.EstimateProductInfoModel":{"required":["quantity"],"type":"object","properties":{"id":{"type":"integer","description":"Unique id of the product (Must be provided if reference_id is unknown)","format":"int32"},"quantity":{"maximum":199,"minimum":1,"type":"integer","description":"The quantity of this product ordered","format":"int32"},"reference_id":{"type":"string","description":"Unique reference id of the product (Must be provided if ID is unknown)","example":"TShirtBlueM"}},"additionalProperties":false},"Orders.EstimateViewModel":{"type":"object","properties":{"estimates":{"type":"array","items":{"$ref":"#/components/schemas/Orders.EstimateDetailViewModel"},"description":"Array of estimates for each shipping method"}},"additionalProperties":false},"Orders.EstimationAddressViewModel":{"required":["country"],"type":"object","properties":{"address1":{"type":"string","description":"First line of the address","example":"100 Nowhere Blvd"},"address2":{"type":"string","description":"Second line of the address","example":"Suite 100"},"city":{"type":"string","description":"The city","example":"Gotham City"},"company_name":{"type":"string","description":"Name of the company receiving the shipment","example":"Wayne Enterprises"},"country":{"minLength":1,"type":"string","description":"The country (Must be ISO Alpha-2 for estimates)","example":"US"},"state":{"type":"string","description":"The state or province","example":"NJ"},"zip_code":{"type":"string","description":"The zip code or postal code","format":"postal-code","example":"07093"}},"additionalProperties":false},"Orders.Financial":{"type":"object","properties":{"total_price":{"type":"number","description":"Sum of all line item prices, discounts, and taxes in USD","format":"double"}},"additionalProperties":false},"Orders.Financials":{"type":"object","properties":{"total_price":{"type":"number","description":"Sum of all line item prices, discounts, and taxes in USD","format":"double"}},"additionalProperties":false},"Orders.FulfillmentCenterViewModel":{"type":"object","properties":{"id":{"type":"integer","description":"Id of the fulfillment center","format":"int32"},"name":{"type":"string","description":"Name of the fulfillment center","example":"Cicero (IL)"}},"additionalProperties":false,"description":"Information about a fulfillment center that a shipment can belong to"},"Orders.FulfillmentStatu":{"enum":["AwaitingInventoryAllocation","AwaitingReset","Unavailable","PendingOnTime","FulfilledOnTime","PendingLate","FulfilledLate"],"type":"string"},"Orders.FulfillmentStatus":{"enum":["AwaitingInventoryAllocation","AwaitingReset","Unavailable","PendingOnTime","FulfilledOnTime","PendingLate","FulfilledLate"],"type":"string"},"Orders.Get.Api.Order.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Orders.Get.Api.Order.EndDate.String":{"type":"string","format":"date-time"},"Orders.Get.Api.Order.HasTracking.Boolea":{"type":"boolean"},"Orders.Get.Api.Order.HasTracking.Boolean":{"type":"boolean"},"Orders.Get.Api.Order.IDs.IntegerArray":{"type":"array","items":{"type":"integer","format":"int32"}},"Orders.Get.Api.Order.IsTrackingUploaded.Boolea":{"type":"boolean"},"Orders.Get.Api.Order.IsTrackingUploaded.Boolean":{"type":"boolean"},"Orders.Get.Api.Order.LastTrackingUpdateEndDate.String":{"type":"string","format":"date-time"},"Orders.Get.Api.Order.LastTrackingUpdateStartDate.String":{"type":"string","format":"date-time"},"Orders.Get.Api.Order.LastUpdateEndDate.String":{"type":"string","format":"date-time"},"Orders.Get.Api.Order.LastUpdateStartDate.String":{"type":"string","format":"date-time"},"Orders.Get.Api.Order.Limit.Integer":{"maximum":250,"minimum":1,"type":"integer","format":"int32"},"Orders.Get.Api.Order.OrderId.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Orders.Get.Api.Order.OrderId.OrderId.Integer":{"type":"integer","format":"int32"},"Orders.Get.Api.Order.OrderId.Shipbob.Channel.Id.Integer":{"type":"integer","format":"int32"},"Orders.Get.Api.Order.OrderId.Shipment.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Orders.Get.Api.Order.OrderId.Shipment.OK.OneOfArray":{"type":"array","items":{"description":"Information about a shipment"}},"Orders.Get.Api.Order.OrderId.Shipment.OrderId.Integer":{"type":"integer","format":"int32"},"Orders.Get.Api.Order.OrderId.Shipment.Shipbob.Channel.Id.Integer":{"type":"integer","format":"int32"},"Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.Logs.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.Logs.OrderId.Integer":{"type":"integer","format":"int32"},"Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.Logs.Shipbob.Channel.Id.Integer":{"type":"integer","format":"int32"},"Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.Logs.ShipmentId.Integer":{"type":"integer","format":"int32"},"Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.OK.OneOf.ShipmentViewModel.InternalShipmentViewModel":{"description":"Information about a shipment"},"Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.OrderId.Integer":{"type":"integer","format":"int32"},"Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.Shipbob.Channel.Id.Integer":{"type":"integer","format":"int32"},"Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.ShipmentId.Integer":{"type":"integer","format":"int32"},"Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.Timeline.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.Timeline.OrderId.Integer":{"type":"integer","format":"int32"},"Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.Timeline.Shipbob.Channel.Id.Integer":{"type":"integer","format":"int32"},"Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.Timeline.ShipmentId.Integer":{"type":"integer","format":"int32"},"Orders.Get.Api.Order.OrderId.StoreOrderJson.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Orders.Get.Api.Order.OrderId.StoreOrderJson.OK.String":{"type":"string"},"Orders.Get.Api.Order.OrderId.StoreOrderJson.OrderId.Integer":{"type":"integer","format":"int32"},"Orders.Get.Api.Order.OrderId.StoreOrderJson.Unprocessable.Entity.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Orders.Get.Api.Order.Page.Integer":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"},"Orders.Get.Api.Order.ReferenceIds.StringArray":{"type":"array","items":{"type":"string"}},"Orders.Get.Api.Order.Shipbob.Channel.Id.Integer":{"type":"integer","format":"int32"},"Orders.Get.Api.Order.StartDate.String":{"type":"string","format":"date-time"},"Orders.Get.Api.Shipment.ListByStatus.AsOfStatusDate.String":{"type":"string","format":"date-time"},"Orders.Get.Api.Shipment.ListByStatus.Limit.Integer":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"},"Orders.Get.Api.Shipment.ListByStatus.Page.Integer":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"},"Orders.Get.Api.Shipment.ListByStatus.Shipbob.Channel.Id.Integer":{"type":"integer","format":"int32"},"Orders.Get.Api.Shipment.PickedNotShippedInventory.FulfillmentCenterId.Integer":{"type":"integer","format":"int32"},"Orders.Get.Api.Shipment.PickedNotShippedInventory.Shipbob.Channel.Id.Integer":{"type":"integer","format":"int32"},"Orders.Get.Api.Shipment.ShipmentId.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Orders.Get.Api.Shipment.ShipmentId.Logs.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Orders.Get.Api.Shipment.ShipmentId.Logs.Shipbob.Channel.Id.Integer":{"type":"integer","format":"int32"},"Orders.Get.Api.Shipment.ShipmentId.Logs.ShipmentId.Integer":{"type":"integer","format":"int32"},"Orders.Get.Api.Shipment.ShipmentId.OK.OneOf.ShipmentViewModel.InternalShipmentViewModel":{"description":"Information about a shipment"},"Orders.Get.Api.Shipment.ShipmentId.Shipbob.Channel.Id.Integer":{"type":"integer","format":"int32"},"Orders.Get.Api.Shipment.ShipmentId.ShipmentId.Integer":{"type":"integer","format":"int32"},"Orders.Get.Api.Shipment.ShipmentId.Timeline.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Orders.Get.Api.Shipment.ShipmentId.Timeline.Shipbob.Channel.Id.Integer":{"type":"integer","format":"int32"},"Orders.Get.Api.Shipment.ShipmentId.Timeline.ShipmentId.Integer":{"type":"integer","format":"int32"},"Orders.Get.Api.Shippingmethod.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Orders.Get.Api.Shippingmethod.Limit.Integer":{"maximum":250,"minimum":1,"type":"integer","format":"int32"},"Orders.Get.Api.Shippingmethod.Page.Integer":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32"},"Orders.Get.Api.Shippingmethod.Unprocessable.Entity.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Orders.InternalShipmentViewModel":{"type":"object","allOf":[{"$ref":"#/components/schemas/Orders.ShipmentViewModel"}],"properties":{"store_order_id":{"type":"string","description":"Unique store order id of the shipment"}},"additionalProperties":false},"Orders.InventoryPickedNotShippedViewModel":{"type":"object","properties":{"expiration_date":{"type":"string","description":"Expiration date of the inventory","format":"date-time"},"fulfillment_center_id":{"type":"integer","format":"int32"},"inventory_id":{"type":"integer","format":"int32"},"lot_number":{"type":"string","description":"Lot number of the inventory","example":"22222"},"name":{"type":"string"},"quantity":{"type":"integer","format":"int32"},"sku":{"type":"string"}},"additionalProperties":false},"Orders.InventoryPickedNotShippedViewModelArray":{"type":"array","items":{"$ref":"#/components/schemas/Orders.InventoryPickedNotShippedViewModel"}},"Orders.InventoryViewModel":{"type":"object","properties":{"expiration_date":{"type":"string","description":"Expiration date of the inventory","format":"date-time"},"id":{"type":"integer","description":"Unique id of the inventory","format":"int32"},"is_dangerous_goods":{"type":"boolean","description":"Is inventory Dangerous Good","example":true},"lot":{"type":"string","description":"Lot number of the inventory","example":"22222"},"name":{"type":"string","description":"Name of the inventory item","example":"Medium Blue T-Shirt"},"quantity":{"type":"integer","description":"Quantity of the inventory item to be included in the fulfillment","format":"int32"},"quantity_committed":{"type":"integer","description":"The quantity of the inventory item allocated from the assigned fulfillment center and committed to the order. If quantity committed is less than order quantity, then the inventory item is out of stock at the assigned fulfillment center.","format":"int32"},"serial_numbers":{"type":"array","items":{"type":"string"},"description":"Serial number of the inventory"}},"additionalProperties":false,"description":"Information about inventory belonging to a store product"},"Orders.MeasurementsViewModel":{"type":"object","properties":{"depth_in":{"type":"integer","description":"Total depth in inches","format":"int32"},"length_in":{"type":"integer","description":"Total length in inches","format":"int32"},"total_weight_oz":{"type":"integer","description":"Total weight in ounces","format":"int32"},"width_in":{"type":"integer","description":"Total width in inches","format":"int32"}},"additionalProperties":false,"description":"Measurements of a shipment"},"Orders.OrderStatu":{"enum":["Processing","Exception","PartiallyFulfilled","Fulfilled","Cancelled","ImportReview"],"type":"string"},"Orders.OrderStatus":{"enum":["Processing","Exception","PartiallyFulfilled","Fulfilled","Cancelled","ImportReview"],"type":"string"},"Orders.OrderStatusEnum":{"enum":["None","Processing","Completed","Exception","OnHold","Cancelled","CleanSweeped","LabeledCreated","ImportReview"],"type":"string"},"Orders.OrderType":{"enum":["DTC","DropShip","B2B"],"type":"string"},"Orders.OrderVerifyAndSaveAddressRequest":{"required":["city","streetAddress1"],"type":"object","properties":{"CountryCode":{"type":"string","description":"Country code of customer address"},"IsDomestic":{"type":"boolean","description":"IsDomestic flag"},"IsPoBox":{"type":"boolean","description":"IsPoBox flag"},"IsValid":{"type":"boolean","description":"IsValid flag"},"OrderId":{"type":"integer","description":"OrderId","format":"int32"},"OverrideVerification":{"type":"boolean","description":"Override Verification Flag"},"PhoneNumber":{"type":"string","description":"Phonenumber of customer address"},"StreetAddress1":{"minLength":1,"type":"string","description":"Street Address 1"},"StreetAddress2":{"type":"string","description":"Streed Address 2"},"ZipCode":{"type":"string","description":"Zipcode of customer address"},"city":{"minLength":1,"type":"string","description":"City of customer address"},"email":{"type":"string","description":"Customer's email address"},"name":{"type":"string","description":"Name of customer"},"state":{"type":"string","description":"State of customer address"}},"additionalProperties":false,"description":"Request model for verify and save address for order"},"Orders.OrderViewModel":{"type":"object","properties":{"channel":{"$ref":"#/components/schemas/Orders.ChannelInfoViewModel"},"created_date":{"type":"string","description":"Date this order was created","format":"date-time"},"financials":{"$ref":"#/components/schemas/Orders.Financials"},"gift_message":{"type":"string","description":"Gift message associated with the order"},"id":{"type":"integer","description":"Unique id of the order","format":"int32"},"order_number":{"type":"string","description":"User friendly orderId or store order number that will be shown on the Orders Page. If not provided, referenceId will be used"},"products":{"type":"array","items":{"$ref":"#/components/schemas/Orders.ProductInfoViewModel"},"description":"List of products included in the order"},"purchase_date":{"type":"string","description":"Date this order was purchase by the end user","format":"date-time"},"recipient":{"$ref":"#/components/schemas/Orders.RecipientInfoViewModel"},"reference_id":{"type":"string","description":"Client-defined external unique id of the order"},"retailer_program_data":{"$ref":"#/components/schemas/Orders.RetailerProgramDataViewModel"},"shipments":{"type":"array","items":{"description":"Information about a shipment"},"description":"Shipments affiliated with the order"},"shipping_method":{"type":"string","description":"Client-defined shipping method","example":"Free 2-day Shipping"},"shipping_terms":{"$ref":"#/components/schemas/Orders.ShippingTermsViewModel"},"status":{"$ref":"#/components/schemas/Orders.OrderStatus"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/Orders.TagViewModel"},"description":"Client-defined order tags"},"type":{"$ref":"#/components/schemas/Orders.OrderType"}},"additionalProperties":false},"Orders.OrderViewModelArray":{"type":"array","items":{"$ref":"#/components/schemas/Orders.OrderViewModel"}},"Orders.PackageMaterialType":{"enum":["Unknown","Box","BubbleMailer","PolyMailer","FragileBox","PosterTube","Custom","Bookfold","OwnContainer","Undefined"],"type":"string"},"Orders.ParentCartonViewModel":{"type":"object","properties":{"barcode":{"type":"string","description":"Barcode assigned to this carton"},"cartons":{"type":"array","items":{"$ref":"#/components/schemas/Orders.CartonViewModel"},"description":"Cartons packed inside this parent container"},"measurements":{"$ref":"#/components/schemas/Orders.CartonMeasurementsViewModel"},"type":{"type":"string","description":"Type of this carton container","example":"Box or pallet"}},"additionalProperties":false},"Orders.PaymentShipTerm":{"enum":["Collect","ThirdParty","Prepaid","MerchantResponsible"],"type":"string"},"Orders.Post.Api.Order.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Orders.Post.Api.Order.Estimate.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Orders.Post.Api.Order.Estimate.Shipbob.Channel.Id.Integer":{"type":"integer","format":"int32"},"Orders.Post.Api.Order.Estimate.Unprocessable.Entity.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Orders.Post.Api.Order.OrderId.Cancel.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Orders.Post.Api.Order.OrderId.Cancel.Internal.Server.Error.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Orders.Post.Api.Order.OrderId.Cancel.OrderId.Integer":{"type":"integer","format":"int32"},"Orders.Post.Api.Order.OrderId.Cancel.Shipbob.Channel.Id.Integer":{"type":"integer","format":"int32"},"Orders.Post.Api.Order.OrderId.Cancel.Unprocessable.Entity.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Orders.Post.Api.Order.OrderId.Shipment.ShipmentId.Cancel.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Orders.Post.Api.Order.OrderId.Shipment.ShipmentId.Cancel.Internal.Server.Error.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Orders.Post.Api.Order.OrderId.Shipment.ShipmentId.Cancel.OK.OneOf.ShipmentViewModel.InternalShipmentViewModel":{"description":"Information about a shipment"},"Orders.Post.Api.Order.OrderId.Shipment.ShipmentId.Cancel.OrderId.String":{"type":"string"},"Orders.Post.Api.Order.OrderId.Shipment.ShipmentId.Cancel.Shipbob.Channel.Id.Integer":{"type":"integer","format":"int32"},"Orders.Post.Api.Order.OrderId.Shipment.ShipmentId.Cancel.ShipmentId.Integer":{"type":"integer","format":"int32"},"Orders.Post.Api.Order.OrderId.Shipment.ShipmentId.Cancel.Unprocessable.Entity.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Orders.Post.Api.Order.OrderId.StoreOrderJson.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Orders.Post.Api.Order.OrderId.StoreOrderJson.Created.String":{"type":"string"},"Orders.Post.Api.Order.OrderId.StoreOrderJson.OrderId.Integer":{"type":"integer","format":"int32"},"Orders.Post.Api.Order.OrderId.StoreOrderJson.Unprocessable.Entity.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Orders.Post.Api.Order.Shipbob.Channel.Id.Integer":{"type":"integer","format":"int32"},"Orders.Post.Api.Order.Unprocessable.Entity.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Orders.Post.Api.Shipment.BulkUpdateTrackingUpload.Bad.Request.String":{"type":"string"},"Orders.Post.Api.Shipment.Cancelbulk.Internal.Server.Error.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Orders.Post.Api.Shipment.Cancelbulk.Shipbob.Channel.Id.Integer":{"type":"integer","format":"int32"},"Orders.Post.Api.Shipment.Cancelbulk.Unprocessable.Entity.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Orders.Post.Api.Shipment.ShipmentId.Cancel.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Orders.Post.Api.Shipment.ShipmentId.Cancel.Internal.Server.Error.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Orders.Post.Api.Shipment.ShipmentId.Cancel.OK.OneOf.ShipmentViewModel.InternalShipmentViewModel":{"description":"Information about a shipment"},"Orders.Post.Api.Shipment.ShipmentId.Cancel.Shipbob.Channel.Id.Integer":{"type":"integer","format":"int32"},"Orders.Post.Api.Shipment.ShipmentId.Cancel.ShipmentId.Integer":{"type":"integer","format":"int32"},"Orders.Post.Api.Shipment.ShipmentId.Cancel.Unprocessable.Entity.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Orders.ProductInfoViewModel":{"type":"object","properties":{"external_line_id":{"type":"integer","description":"Numeric assignment per item. Used as a reference number for multiple purposes such as split orders, split containers, etc.","format":"int32"},"gtin":{"type":"string","description":"Global Trade Item Number - unique and internationally recognized identifier assigned to item by company GS1"},"id":{"type":"integer","description":"Unique id of the product","format":"int32"},"quantity":{"type":"integer","description":"The quantity of this product ordered","format":"int32"},"quantity_unit_of_measure_code":{"type":"string","description":"Defined standard for measure for an item (each, inner pack, case, pallet).  Values: EA, INP, CS and PL"},"reference_id":{"type":"string","description":"Unique reference id of the product","example":"TShirtBlueM"},"sku":{"type":"string","description":"Stock keeping unit for the product","example":"TShirtBlueM"},"unit_price":{"type":"number","description":"Price for one item","format":"double"},"upc":{"type":"string","description":"Universal Product Code - Unique external identifier"}},"additionalProperties":false},"Orders.Put.Api.Shipment.ShipmentId.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Orders.Put.Api.Shipment.ShipmentId.OK.OneOfArray":{"type":"array","items":{"description":"Information about a shipment"}},"Orders.Put.Api.Shipment.ShipmentId.Shipbob.Channel.Id.Integer":{"type":"integer","format":"int32"},"Orders.Put.Api.Shipment.ShipmentId.ShipmentId.Integer":{"type":"integer","format":"int32"},"Orders.RecipientInfoViewModel":{"required":["address","name"],"type":"object","properties":{"address":{"description":"Address of the recipient"},"email":{"type":"string","description":"Email address of the recipient","format":"email","example":"john@example.com"},"name":{"maxLength":300,"minLength":1,"type":"string","description":"Name of the recipient","example":"John Doe"},"phone_number":{"maxLength":50,"type":"string","description":"Phone number of the recipient","example":"555-555-5555"}},"additionalProperties":false,"description":"Information about the recipient of an order"},"Orders.RecipientViewModel":{"type":"object","properties":{"address":{"description":"Address of the recipient"},"email":{"type":"string","description":"Email address of the recipient","format":"email","example":"john@example.com"},"full_name":{"type":"string","description":"FullName of the recipient","example":"John Doe"},"name":{"type":"string","description":"Name of the recipient","example":"John Doe"},"phone_number":{"type":"string","description":"Phone number of the recipient","format":"tel","example":"555-555-5555"}},"additionalProperties":false,"description":"Information about the recipient of a shipment"},"Orders.RetailerProgramDataAddressViewModel":{"required":["type"],"type":"object","allOf":[{"$ref":"#/components/schemas/Orders.AddressViewModel"}],"properties":{"type":{"$ref":"#/components/schemas/Orders.AddressType"}},"additionalProperties":false,"description":"Address to used when creating a B2B/DropShip order."},"Orders.RetailerProgramDataViewModel":{"required":["purchaseOrderNumber","retailerProgramType"],"type":"object","properties":{"addresses":{"type":"array","items":{"$ref":"#/components/schemas/Orders.RetailerProgramDataAddressViewModel"},"description":"Ship From - Certain retailers want to display the ship from address as their return facility, not Shipbob’s warehouse address        /// \r\nMark For Address - Final destination address"},"customer_ticket_number":{"type":"string","description":"Customer Ticket Number"},"delivery_date":{"type":"string","description":"Expected delivery date","format":"date-time"},"department":{"type":"string","description":"Identifies a merchant's store department"},"doNotShipBeforeDate":{"type":"string","description":"The date the retailer does not want the order shipped by.","format":"date-time"},"mark_for_store":{"type":"string","description":"Store Number"},"purchase_order_number":{"minLength":1,"type":"string","description":"First initial documentation sent from buyer to seller with item(s) and quantities."},"retailer_program_type":{"minLength":1,"type":"string","description":"Identifies retailer-merchant combination"},"shipByDate":{"type":"string","description":"The date the retailer has requested the order to ship by.","format":"date-time"}},"additionalProperties":false,"description":"Contains properties that needs to be used for fulfilling B2B/Dropship orders."},"Orders.ServiceLevelDetailViewModel":{"type":"object","properties":{"id":{"type":"integer","description":"Unique id for the service level","format":"int32"},"name":{"type":"string","description":"The name or title of the service level"}},"additionalProperties":false},"Orders.ShipMethodDetailViewModel":{"type":"object","properties":{"active":{"type":"boolean","description":"Indicates if the shipping method is active"},"default":{"type":"boolean","description":"Indicates the shipping method is a ShipBob default shipping method."},"id":{"type":"integer","description":"Unique id for shipping method.","format":"int32"},"name":{"type":"string","description":"Name of the ship method as selected by the merchant and saved in ShipBob’s database (i.e. “ground”). Corresponds to the shipping_method field in the Orders API."},"service_level":{"$ref":"#/components/schemas/Orders.ServiceLevelDetailViewModel"}},"additionalProperties":false},"Orders.ShipMethodDetailViewModelArray":{"type":"array","items":{"$ref":"#/components/schemas/Orders.ShipMethodDetailViewModel"}},"Orders.ShipmentActi":{"enum":["Cancel"],"type":"string"},"Orders.ShipmentAction":{"enum":["CleanSweep","Reassign","ReleaseOrderHold","MoveToOnHoldAndKeepInventory","MoveToOnHoldAndReleaseInventory","Cancel","AddLineItem","RemoveLineItem","UpdateShipOption"],"type":"string"},"Orders.ShipmentLogViewModel":{"type":"object","properties":{"log_type_id":{"type":"integer","description":"Log type id of the shipment","format":"int32"},"log_type_name":{"type":"string","description":"Name of the log type"},"log_type_text":{"type":"string","description":"Summary of log type meaning"},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Specifics data for the event"},"timestamp":{"type":"string","description":"Timestamp of event","format":"date-time"}},"additionalProperties":false},"Orders.ShipmentLogViewModelArray":{"type":"array","items":{"$ref":"#/components/schemas/Orders.ShipmentLogViewModel"}},"Orders.ShipmentProductViewModel":{"type":"object","properties":{"id":{"type":"integer","description":"Unique id of the product","format":"int32"},"inventory_items":{"type":"array","items":{"$ref":"#/components/schemas/Orders.InventoryViewModel"},"description":"Information about fulfillable inventory items belonging to this product"},"name":{"type":"string","description":"Name of the product","example":"Medium Blue T-Shirt"},"reference_id":{"type":"string","description":"Unique reference id of the product","example":"TShirtBlueM"},"sku":{"type":"string","description":"Stock keeping unit for the product","example":"TShirtBlueM"}},"additionalProperties":false,"description":"Information about a store product belonging to a shipment"},"Orders.ShipmentStatusFilter":{"enum":["Processing","OnHold","Exception","Picked","Packed","Shipped","InTransit","Delivered","DeliveryException"],"type":"string"},"Orders.ShipmentStatusViewModel":{"type":"object","properties":{"location_id":{"type":"integer","description":"Unique ShipBob Id of the Fulfillment Center to which the shipment was assigned","format":"int32"},"order_id":{"type":"integer","description":"Unique ShipBob Id of the parent order","format":"int64"},"reference_id":{"type":"string","description":"The Reference Id ingested with the original order"},"shipment_id":{"type":"integer","description":"Unique ShipBob Id of the shipment","format":"int32"},"status_datetime":{"type":"string","description":"Datetime when the shipment entered into the requested status (according to request filters)","format":"date-time"},"store_order_id":{"type":"string","description":"The Store Order Id ingested with the original order"},"store_order_tags":{"type":"string","description":"The raw tag data ingested with the original store order"}},"additionalProperties":false},"Orders.ShipmentStatusViewModelArray":{"type":"array","items":{"$ref":"#/components/schemas/Orders.ShipmentStatusViewModel"}},"Orders.ShipmentViewModel":{"type":"object","properties":{"actual_fulfillment_date":{"type":"string","description":"The datetime of ShipBob’s completion of the fulfillment operation as promised.\r\nCurrently, this means the shipment has been picked, packed, and label has been printed.","format":"date-time"},"created_date":{"type":"string","description":"Date this shipment was created","format":"date-time"},"delivery_date":{"type":"string","description":"The datetime of Shipment delivered to customer.","format":"date-time"},"estimated_fulfillment_date":{"type":"string","description":"The datetime of ShipBob’s commitment for completing\r\nthe shipment and handing to the carrier for delivery.","format":"date-time"},"estimated_fulfillment_date_status":{"$ref":"#/components/schemas/Orders.FulfillmentStatus"},"gift_message":{"maxLength":500,"type":"string","description":"Gift message associated with the shipment"},"id":{"type":"integer","description":"Unique id of the shipment","format":"int32"},"insurance_value":{"type":"number","description":"Monetary amount that this shipment was insured for","format":"currency"},"invoice_amount":{"type":"number","description":"Monetary amount that was invoiced for this shipment","format":"currency"},"invoice_currency_code":{"type":"string"},"is_tracking_uploaded":{"type":"boolean","description":"Indicates whether the Shipment was marked with tracking information\r\nuploaded to a third-party system where the order originated."},"last_tracking_update_at":{"type":"string","description":"Timestamp for the last time this shipment had a tracking update","format":"date-time"},"last_update_at":{"type":"string","description":"Date this shipment was last updated","format":"date-time"},"location":{"$ref":"#/components/schemas/Orders.FulfillmentCenterViewModel"},"measurements":{"$ref":"#/components/schemas/Orders.MeasurementsViewModel"},"order_id":{"type":"integer","description":"Id of the order this shipment belongs to","format":"int32"},"package_material_type":{"$ref":"#/components/schemas/Orders.PackageMaterialType"},"parent_cartons":{"type":"array","items":{"$ref":"#/components/schemas/Orders.ParentCartonViewModel"},"description":"Carton information for this shipment"},"products":{"type":"array","items":{"$ref":"#/components/schemas/Orders.ShipmentProductViewModel"},"description":"Information about the products contained in this shipment"},"recipient":{"$ref":"#/components/schemas/Orders.RecipientViewModel"},"reference_id":{"type":"string","description":"Client-defined external unique id of the order this shipment belongs to"},"require_signature":{"type":"boolean","description":"If a shipment requires signature"},"ship_option":{"type":"string","description":"Name of the shipping option used for this shipment","example":"Standard"},"status":{"$ref":"#/components/schemas/Orders.OrderStatusEnum"},"status_details":{"type":"array","items":{"$ref":"#/components/schemas/Orders.StatusDetailViewModel"},"description":"Additional details about the shipment status"},"tracking":{"$ref":"#/components/schemas/Orders.TrackingViewModel"}},"additionalProperties":false,"description":"Information about a shipment"},"Orders.ShippingTermsViewModel":{"type":"object","properties":{"carrier_type":{"$ref":"#/components/schemas/Orders.CarrierShipType"},"payment_term":{"$ref":"#/components/schemas/Orders.PaymentShipTerm"}},"additionalProperties":false,"description":"Contains shipping properties that need to be used for fulfilling an order."},"Orders.SortOrder":{"enum":["Newest","Oldest"],"type":"string"},"Orders.StatusDetailViewModel":{"type":"object","properties":{"description":{"type":"string","description":"Describes what the status detail means"},"exception_fulfillment_center_id":{"type":"integer","format":"int32"},"extra_information":{"$ref":"#/components/schemas/Orders.StatusInformationViewModel"},"id":{"type":"integer","description":"The id of the status detail","format":"int32"},"inventory_id":{"type":"integer","description":"Inventory Id the detail applies to (if applicable)","format":"int32"},"name":{"type":"string","description":"Short name of the status detail"}},"additionalProperties":false},"Orders.StatusInformationViewModel":{"type":"object","properties":{"validation_messages":{"type":"array","items":{"type":"string"}}},"additionalProperties":false},"Orders.TagViewModel":{"required":["name","value"],"type":"object","properties":{"name":{"maxLength":50,"minLength":1,"type":"string","description":"The key of the tag","example":"Handling instructions"},"value":{"maxLength":500,"minLength":1,"type":"string","description":"The value of the tag","example":"Fragile"}},"additionalProperties":false},"Orders.TrackingViewModel":{"type":"object","properties":{"bol":{"type":"string","description":"Bill of lading (BOL) number. Document acknowledging receipt of cargo for shipment."},"carrier":{"type":"string","description":"Carrier of the shipment","example":"USPS"},"carrier_service":{"type":"string","description":"The carrier's service which was used for this shipment","example":"Priority"},"pro_number":{"type":"string","description":"Tracking number used for freight carriers"},"scac":{"type":"string","description":"Standard Carrier Alpha Code (SCAC). Unique 2-4 letter code used to identify transportation companies."},"shipping_date":{"type":"string","description":"Date freight was shipped on","format":"date-time"},"tracking_number":{"type":"string","description":"Tracking number of the shipment","example":"860C8CDC8F0B4FC7AB69AC86C20539EC"},"tracking_url":{"type":"string","description":"URL to the website where a shipment can be tracked","example":"https://www.example.com/tracking?id=860C8CDC8F0B4FC7AB69AC86C20539EC"}},"additionalProperties":false,"description":"Tracking information for a shipment"},"Orders.UpdateShipmentModel":{"type":"object","properties":{"is_tracking_uploaded":{"type":"boolean","description":"Indicates whether the Shipment was marked with tracking information\r\nuploaded to a third-party system where the order originated."}},"additionalProperties":false,"description":"Model for Updating multiple shipments of the same Order"},"Products.AdditionalHazmatAttributesRequestModel":{"type":"object","properties":{"charge_state_percentage":{"type":"number","format":"double"},"container_metal":{"type":"boolean"},"lithium_battery_packaging":{"type":"string"},"lithium_battery_type":{"type":"string"},"magnet":{"type":"boolean"},"net_volume":{"type":"number","format":"double"},"net_weight":{"type":"number","format":"double"}},"additionalProperties":false},"Products.AdditionalHazmatAttributesViewModel":{"type":"object","properties":{"charge_state_percentage":{"type":"number","format":"double"},"container_metal":{"type":"boolean"},"lithium_battery_packaging":{"type":"string"},"lithium_battery_type":{"type":"string"},"magnet":{"type":"boolean"},"net_volume":{"type":"number","format":"double"},"net_weight":{"type":"number","format":"double"}},"additionalProperties":false},"Products.AmazonChannelMetadataRequestModel":{"type":"object","allOf":[{"$ref":"#/components/schemas/Products.BaseChannelMetadataRequestModel"}],"properties":{"asin":{"type":"string"},"fnsku":{"type":"string"},"fulfillment_channel":{"type":"string"},"platform":{"type":"string","readOnly":true}},"additionalProperties":false,"description":"Amazon Sales Channel Information with custom Amazon Fields"},"Products.AmazonChannelMetadataViewModel":{"type":"object","allOf":[{"$ref":"#/components/schemas/Products.ChannelMetadataViewModel"}],"properties":{"asin":{"type":"string"},"fnsku":{"type":"string"},"fulfillment_channel":{"type":"string"}},"additionalProperties":false},"Products.ApplicableCategoryViewModel":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"sub_category_ids":{"type":"array","items":{"type":"integer","format":"int32"}}},"additionalProperties":false},"Products.AssociatedBundlesViewModel":{"type":"object","properties":{"product_id":{"type":"integer","format":"int64"},"product_name":{"type":"string"},"quantity":{"type":"integer","format":"int32"},"variant_id":{"type":"integer","format":"int64"},"variant_sku":{"type":"string"}},"additionalProperties":false},"Products.BaseChannelMetadataRequestModel":{"type":"object","allOf":[{"$ref":"#/components/schemas/Products.ChannelMetadataRequestModel"}],"additionalProperties":false,"description":"Standard Channel Metadata Record to store SellerSKU for a Sales Channel"},"Products.BaseProductRequestModel":{"type":"object","properties":{"category_id":{"type":"integer","format":"int32"},"name":{"type":"string"},"sub_category_id":{"type":"integer","format":"int32"},"type_id":{"type":"integer","format":"int32"}},"additionalProperties":false},"Products.BaseProductVariantRequestModel":{"type":"object","properties":{"barcode":{"type":"string"},"bundle_definition":{"type":"array","items":{"$ref":"#/components/schemas/Products.BundleDefinitionRequestModel"}},"channel_metadata":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Products.AmazonChannelMetadataRequestModel"},{"$ref":"#/components/schemas/Products.BaseChannelMetadataRequestModel"},{"$ref":"#/components/schemas/Products.BigCommerceChannelMetadataRequestModel"},{"$ref":"#/components/schemas/Products.ShopifyChannelMetadataRequestModel"}]}},"customs":{"$ref":"#/components/schemas/Products.CustomsRequestModel"},"dimension":{"$ref":"#/components/schemas/Products.DimensionRequestModel"},"fulfillment_settings":{"$ref":"#/components/schemas/Products.FulfillmentSettingsRequestModel"},"gtin":{"type":"string"},"is_digital":{"type":"boolean"},"lot_information":{"$ref":"#/components/schemas/Products.LotInformationRequestModel"},"name":{"type":"string"},"packaging_material_type_id":{"type":"integer","format":"int32"},"packaging_requirement_id":{"type":"integer","format":"int32"},"return_preferences":{"$ref":"#/components/schemas/Products.ReturnPreferencesRequestModel"},"sku":{"type":"string"},"status_id":{"type":"integer","format":"int32"},"upc":{"type":"string"},"weight":{"type":"number","format":"double"}},"additionalProperties":false},"Products.BaseTaxonomyViewModel":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"path":{"type":"string"}},"additionalProperties":false},"Products.BaseViewRequestModel":{"type":"object","properties":{"column_definitions":{"type":"array","items":{"$ref":"#/components/schemas/Products.ColumnDefinitionModel"}},"filters":{"nullable":true},"name":{"type":"string"},"order":{"type":"integer","format":"int32"},"sort":{"nullable":true}},"additionalProperties":false},"Products.BigCommerceChannelMetadataRequestModel":{"type":"object","allOf":[{"$ref":"#/components/schemas/Products.BaseChannelMetadataRequestModel"}],"properties":{"platform":{"type":"string","readOnly":true},"platform_product_id":{"type":"integer","format":"int64"},"platform_variant_id":{"type":"integer","format":"int64"}},"additionalProperties":false,"description":"BigCommerce Sales Channel Information with custom Amazon Fields"},"Products.BigCommerceChannelMetadataViewModel":{"type":"object","allOf":[{"$ref":"#/components/schemas/Products.ChannelMetadataViewModel"}],"properties":{"platform_product_id":{"type":"integer","format":"int64"},"platform_variant_id":{"type":"integer","format":"int64"}},"additionalProperties":false},"Products.BundleDefinitionRequestModel":{"type":"object","properties":{"quantity":{"type":"integer","format":"int32"},"variant_id":{"type":"integer","format":"int64"}},"additionalProperties":false},"Products.BundleDefinitionViewModel":{"type":"object","properties":{"product_id":{"type":"integer","format":"int64"},"quantity":{"type":"integer","format":"int32"},"variant_id":{"type":"integer","format":"int64"},"variant_name":{"type":"string"},"variant_sku":{"type":"string"}},"additionalProperties":false},"Products.CategoryViewModel":{"type":"object","properties":{"created_on":{"type":"string","format":"date-time"},"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"status":{"type":"string"},"sub_categories":{"type":"array","items":{"$ref":"#/components/schemas/Products.SubCategoryViewModel"}},"updated_on":{"type":"string","format":"date-time"}},"additionalProperties":false},"Products.CategoryViewModelArray":{"type":"array","items":{"$ref":"#/components/schemas/Products.CategoryViewModel"}},"Products.ChannelMetadataRequestModel":{"type":"object","properties":{"channel_id":{"type":"integer","format":"int32"},"currency":{"type":"string"},"id":{"type":"integer","format":"int64"},"is_inventory_sync_enabled":{"type":"boolean"},"legacy_product_id":{"type":"integer","format":"int64","readOnly":true},"platform":{"type":"string"},"platform_identifier":{"type":"string"},"platform_inventory_item_id":{"type":"string"},"price":{"type":"number","format":"double"},"seller_sku":{"type":"string"}},"additionalProperties":false},"Products.ChannelMetadataViewModel":{"type":"object","properties":{"channel_id":{"type":"integer","format":"int64"},"channel_name":{"type":"string"},"currency":{"type":"string"},"id":{"type":"integer","format":"int64"},"is_inventory_sync_enabled":{"type":"boolean"},"legacy_product_id":{"type":"integer","format":"int64"},"platform":{"type":"string"},"platform_identifier":{"type":"string"},"platform_inventory_item_id":{"type":"string"},"price":{"type":"number","format":"double"},"seller_sku":{"type":"string"}},"additionalProperties":false},"Products.ChildTaxonomyViewModel":{"type":"object","allOf":[{"$ref":"#/components/schemas/Products.BaseTaxonomyViewModel"}],"properties":{"has_children":{"type":"boolean"}},"additionalProperties":false},"Products.ColumnDefinitionModel":{"type":"object","properties":{"key":{"type":"string"}},"additionalProperties":false},"Products.ConvertVariantToBundleRequest":{"type":"object","properties":{"bundle_definition":{"type":"array","items":{"$ref":"#/components/schemas/Products.BundleDefinitionRequestModel"}},"channel_metadata":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Products.AmazonChannelMetadataRequestModel"},{"$ref":"#/components/schemas/Products.BaseChannelMetadataRequestModel"},{"$ref":"#/components/schemas/Products.BigCommerceChannelMetadataRequestModel"},{"$ref":"#/components/schemas/Products.ShopifyChannelMetadataRequestModel"}]}},"name":{"type":"string"},"sku":{"type":"string"}},"additionalProperties":false},"Products.CreateProductRequestModel":{"type":"object","allOf":[{"$ref":"#/components/schemas/Products.BaseProductRequestModel"}],"properties":{"variants":{"type":"array","items":{"$ref":"#/components/schemas/Products.CreateProductVariantRequestModel"}}},"additionalProperties":false},"Products.CreateProductVariantRequestModel":{"type":"object","allOf":[{"$ref":"#/components/schemas/Products.BaseProductVariantRequestModel"}],"additionalProperties":false},"Products.CreateProductVariantRequestModelArray":{"type":"array","items":{"$ref":"#/components/schemas/Products.CreateProductVariantRequestModel"}},"Products.CreateViewRequestModel":{"type":"object","allOf":[{"$ref":"#/components/schemas/Products.BaseViewRequestModel"}],"additionalProperties":false},"Products.CreateViewRequestModelArray":{"type":"array","items":{"$ref":"#/components/schemas/Products.CreateViewRequestModel"}},"Products.CustomsRequestModel":{"type":"object","properties":{"country_code_of_origin":{"type":"string"},"description":{"type":"string"},"hs_tariff_code":{"type":"string"},"is321_eligible":{"type":"boolean"},"value":{"type":"integer","format":"int32"}},"additionalProperties":false},"Products.CustomsViewModel":{"type":"object","properties":{"country_code_of_origin":{"type":"string"},"currency":{"type":"string"},"description":{"type":"string"},"hs_tariff_code":{"type":"string"},"is321_eligible":{"type":"boolean"},"value":{"type":"integer","format":"int32"}},"additionalProperties":false},"Products.Delete.Api.Internal.View.ViewId.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Products.Delete.Api.Internal.View.ViewId.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetail":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Delete.Api.Internal.View.ViewId.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Delete.Api.Internal.View.ViewId.ViewId.Integer":{"type":"integer","format":"int64"},"Products.Delete.Api.Product.ProductId.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Products.Delete.Api.Product.ProductId.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetail":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Delete.Api.Product.ProductId.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Delete.Api.Product.ProductId.ProductId.Integer":{"type":"integer","format":"int64"},"Products.Delete.Api.Variant.VariantId.ChannelMetadata.ChannelMetadataId.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Products.Delete.Api.Variant.VariantId.ChannelMetadata.ChannelMetadataId.ChannelMetadataId.Integer":{"type":"integer","format":"int64"},"Products.Delete.Api.Variant.VariantId.ChannelMetadata.ChannelMetadataId.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetail":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Delete.Api.Variant.VariantId.ChannelMetadata.ChannelMetadataId.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Delete.Api.Variant.VariantId.ChannelMetadata.ChannelMetadataId.VariantId.Integer":{"type":"integer","format":"int64"},"Products.DimensionRequestModel":{"type":"object","properties":{"height":{"type":"number","format":"double"},"length":{"type":"number","format":"double"},"width":{"type":"number","format":"double"}},"additionalProperties":false},"Products.DimensionViewModel":{"type":"object","properties":{"height":{"type":"number","format":"double"},"length":{"type":"number","format":"double"},"unit":{"type":"string"},"width":{"type":"number","format":"double"}},"additionalProperties":false},"Products.EnumViewModel":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"}},"additionalProperties":false},"Products.FulfillmentSettingsRequestModel":{"type":"object","properties":{"dangerous_goods":{"type":"boolean"},"is_bpm_parcel":{"type":"boolean"},"is_case_pick":{"type":"boolean"},"msds_url":{"type":"string"},"requires_prop65":{"type":"boolean"},"serial_scan":{"$ref":"#/components/schemas/Products.SerialScanRequestModel"}},"additionalProperties":false},"Products.FulfillmentSettingsViewModel":{"type":"object","properties":{"dangerous_goods":{"type":"boolean"},"is_bpm_parcel":{"type":"boolean"},"is_case_pick":{"type":"boolean"},"msds_url":{"type":"string"},"requires_prop65":{"type":"boolean"},"serial_scan":{"$ref":"#/components/schemas/Products.SerialScanViewModel"}},"additionalProperties":false},"Products.Get.Api.Category.Status.String":{"type":"string","default":""},"Products.Get.Api.Product.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Products.Get.Api.Product.Barcode.Int":{"type":"integer","description":"Barcode Associated with variant"},"Products.Get.Api.Product.Barcode.String":{"type":"string","description":"Barcode Associated with variant"},"Products.Get.Api.Product.CategoryIds.List.Int":{"type":"array","items":{"type":"integer"},"description":"List of Category Ids associated with product"},"Products.Get.Api.Product.ChannelIds.List.Int":{"type":"array","items":{"type":"integer"},"description":"Looks for Products variants by their channel IDs"},"Products.Get.Api.Product.HasDigitalVariants.Boolea":{"type":"boolean","description":"Looks for Products with/without digital variants"},"Products.Get.Api.Product.HasDigitalVariants.Boolean":{"type":"boolean","description":"Looks for Products with/without digital variants"},"Products.Get.Api.Product.HasVariants.Boolea":{"type":"boolean","description":"Looks for Products with/without variants"},"Products.Get.Api.Product.HasVariants.Boolean":{"type":"boolean","description":"Looks for Products with/without variants"},"Products.Get.Api.Product.InventoryId.List.Int":{"type":"array","items":{"type":"integer"},"description":"Looks for variants by its associated inventory id"},"Products.Get.Api.Product.LastUpdatedTimestamp.DateTime":{"type":"string","description":"Looks for Products that have been updated since the given date"},"Products.Get.Api.Product.LegacyIds.List.Int":{"type":"array","items":{"type":"integer"},"description":"Looks for Products with by Legacy Product Id(s)"},"Products.Get.Api.Product.Name.String":{"type":"string","description":"Looks for Products/Variants by name"},"Products.Get.Api.Product.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetail":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Get.Api.Product.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Get.Api.Product.OnHand.Integer":{"type":"integer","description":"Looks for Products with inventory"},"Products.Get.Api.Product.PlatformIds.List.String":{"type":"array","items":{"type":"string"},"description":"Looks for Products variants by their external Platform IDs"},"Products.Get.Api.Product.ProductId.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Products.Get.Api.Product.ProductId.List.Int":{"type":"array","items":{"type":"integer"},"description":"Looks for Products with an assigned Id"},"Products.Get.Api.Product.ProductId.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetail":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Get.Api.Product.ProductId.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Get.Api.Product.ProductId.ProductId.Integer":{"type":"integer","format":"int64"},"Products.Get.Api.Product.ProductId.Variants.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Products.Get.Api.Product.ProductId.Variants.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetail":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Get.Api.Product.ProductId.Variants.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Get.Api.Product.ProductId.Variants.ProductId.Integer":{"type":"integer","format":"int64"},"Products.Get.Api.Product.ProductType.Integer":{"type":"integer","description":"Looks for Products by type"},"Products.Get.Api.Product.SKU.String":{"type":"string","description":"Looks for Products that match the provided Sku query"},"Products.Get.Api.Product.SalesChannel.List.String":{"type":"array","items":{"type":"string"},"description":"Looks for Products variants assigned to a platform/sales channel "},"Products.Get.Api.Product.Search.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Products.Get.Api.Product.Search.Limit.Integer":{"type":"integer","format":"int32","default":25},"Products.Get.Api.Product.Search.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetail":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Get.Api.Product.Search.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Get.Api.Product.Search.Page.Integer":{"type":"integer","format":"int32","default":1},"Products.Get.Api.Product.Search.ProductTypeId.Integer":{"type":"integer","format":"int32"},"Products.Get.Api.Product.Search.SearchText.String":{"type":"string"},"Products.Get.Api.Product.Search.String":{"type":"string","description":"Search Products by name, sku, inventory id or product Id"},"Products.Get.Api.Product.SellerSKUEvaludator.String":{"type":"string","description":"Looks for Products that match the provided Seller query"},"Products.Get.Api.Product.VariantId.List.Int":{"type":"array","items":{"type":"integer"},"description":"Looks for products that contain a variant with the given ID"},"Products.Get.Api.Product.VariantStatus.String":{"type":"string","description":"Looks for Products with variants that contain provided status"},"Products.Get.Api.V2.Taxonomy.Forbidden.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Get.Api.V2.Taxonomy.Id.Forbidden.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Get.Api.V2.Taxonomy.Id.Id.Integer":{"type":"integer","format":"int32"},"Products.Get.Api.V2.Taxonomy.Id.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Get.Api.V2.Taxonomy.Id.Parent.Forbidden.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Get.Api.V2.Taxonomy.Id.Parent.Id.Integer":{"type":"integer","format":"int32"},"Products.Get.Api.V2.Taxonomy.Id.Parent.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Get.Api.V2.Taxonomy.Id.Parent.Unauthorized.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Get.Api.V2.Taxonomy.Id.Unauthorized.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Get.Api.V2.Taxonomy.Search.String":{"type":"string"},"Products.Get.Api.V2.Taxonomy.Unauthorized.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Get.Api.V3.Product.Inventory.InventoryId.InventoryId.Integer":{"type":"integer","format":"int64"},"Products.Get.Api.V3.Product.Inventory.InventoryId.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.HttpValidationProblemDetail":{"type":"object","allOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"}],"properties":{"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"additionalProperties":{}},"Products.HttpValidationProblemDetails":{"type":"object","allOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"}],"properties":{"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"additionalProperties":{}},"Products.InventoryViewModel":{"type":"object","properties":{"inventory_id":{"type":"integer","format":"int32"},"on_hand_qty":{"type":"integer","format":"int32"}},"additionalProperties":false},"Products.LotInformationRequestModel":{"type":"object","properties":{"is_lot":{"type":"boolean"},"minimum_shelf_life_days":{"type":"integer","format":"int32"}},"additionalProperties":false},"Products.LotInformationViewModel":{"type":"object","properties":{"is_lot":{"type":"boolean"},"minimum_shelf_life_days":{"type":"integer","format":"int32"}},"additionalProperties":false},"Products.MergeVariantRequestModel":{"type":"object","properties":{"id":{"type":"integer","format":"int64"}},"additionalProperties":false},"Products.MergeVariantRequestModelArray":{"type":"array","items":{"$ref":"#/components/schemas/Products.MergeVariantRequestModel"}},"Products.MergedChildrenViewModel":{"type":"object","properties":{"channel_ids":{"type":"array","items":{"type":"integer","format":"int64"}},"completed_at":{"type":"string","format":"date-time"},"inventory_id":{"type":"integer","format":"int64"},"variant_id":{"type":"integer","format":"int64"},"variant_name":{"type":"string"}},"additionalProperties":false},"Products.MigrateChannelMetadataRequestModel":{"type":"object","properties":{"id":{"type":"integer","description":"ID of the Channel Metadata record to be moved","format":"int64"},"seller_sku":{"type":"string","description":"New SKU for the Channel Metadata record (optional)"}},"additionalProperties":false},"Products.MigrateChannelMetadataRequestModelArray":{"type":"array","items":{"$ref":"#/components/schemas/Products.MigrateChannelMetadataRequestModel"}},"Products.MigrateChannelMetadataToNewProductRequest":{"type":"object","properties":{"category_id":{"type":"integer","format":"int32"},"channel_metadata":{"type":"array","items":{"$ref":"#/components/schemas/Products.MigrateChannelMetadataRequestModel"}},"product_name":{"type":"string"},"sku":{"type":"string"},"sub_category_id":{"type":"integer","format":"int32"}},"additionalProperties":false},"Products.MigrateVariantRequestModel":{"type":"object","properties":{"category_id":{"type":"integer","format":"int32"},"name":{"type":"string"},"product_id":{"type":"integer","format":"int64"},"sub_category_id":{"type":"integer","format":"int32"},"variants":{"type":"array","items":{"$ref":"#/components/schemas/Products.VariantToMigrate"}}},"additionalProperties":false},"Products.PackagingMaterialTypeViewModel":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"}},"additionalProperties":false},"Products.PackagingRequirementViewModel":{"type":"object","properties":{"applicable_categories":{"type":"array","items":{"$ref":"#/components/schemas/Products.ApplicableCategoryViewModel"}},"applicable_packaging_material_types":{"type":"array","items":{"$ref":"#/components/schemas/Products.PackagingMaterialTypeViewModel"}},"description":{"type":"string"},"id":{"type":"integer","format":"int32"},"name":{"type":"string"}},"additionalProperties":false},"Products.PackagingRequirementViewModelArray":{"type":"array","items":{"$ref":"#/components/schemas/Products.PackagingRequirementViewModel"}},"Products.Patch.Api.V3.Product.ProductId.ProductId.Integer":{"type":"integer","format":"int64"},"Products.Patch.Api.V3.Product.ProductId.Variants.ProductId.Integer":{"type":"integer","format":"int64"},"Products.Post.Api.Product.MigrateVariants.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Products.Post.Api.Product.MigrateVariants.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetail":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Post.Api.Product.MigrateVariants.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Post.Api.Product.ProductId.MigrateVariants.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Products.Post.Api.Product.ProductId.MigrateVariants.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetail":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Post.Api.Product.ProductId.MigrateVariants.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Post.Api.Product.ProductId.MigrateVariants.ProductId.Integer":{"type":"integer","format":"int64"},"Products.Post.Api.Product.ProductId.Variants.ProductId.Integer":{"type":"integer","format":"int64"},"Products.Post.Api.Variant.VariantId.ChannelMetadata.Migrate.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Products.Post.Api.Variant.VariantId.ChannelMetadata.Migrate.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetail":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Post.Api.Variant.VariantId.ChannelMetadata.Migrate.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Post.Api.Variant.VariantId.ChannelMetadata.Migrate.VariantId.Integer":{"type":"integer","format":"int64"},"Products.Post.Api.Variant.VariantId.ChannelMetadata.Request.OneOf.AmazonChannelMetadataRequestModel.BaseChannelMetadataRequestModel.BigCommerceChannelMetadataRequestModel.ShopifyChannelMetadataRequestModel":{"oneOf":[{"$ref":"#/components/schemas/Products.AmazonChannelMetadataRequestModel"},{"$ref":"#/components/schemas/Products.BaseChannelMetadataRequestModel"},{"$ref":"#/components/schemas/Products.BigCommerceChannelMetadataRequestModel"},{"$ref":"#/components/schemas/Products.ShopifyChannelMetadataRequestModel"}],"example":{"asin":"string","channel_id":0,"currency":"string","fnsku":"string","fulfillment_channel":"string","id":0,"is_inventory_sync_enabled":true,"legacy_product_id":0,"platform":"string","platform_identifier":"string","platform_inventory_item_id":"string","price":0.1,"seller_sku":"string"}},"Products.Post.Api.Variant.VariantId.ChannelMetadata.VariantId.Integer":{"type":"integer","format":"int64"},"Products.Post.Api.Variant.VariantId.ConvertToBundle.VariantId.Integer":{"type":"integer","format":"int64"},"Products.Post.Api.Variant.VariantId.Merge.VariantId.Integer":{"type":"integer","format":"int64"},"Products.ProblemDetail":{"type":"object","properties":{"detail":{"type":"string"},"instance":{"type":"string"},"status":{"type":"integer","format":"int32"},"title":{"type":"string"},"type":{"type":"string"}},"additionalProperties":{}},"Products.ProblemDetails":{"type":"object","properties":{"detail":{"type":"string"},"instance":{"type":"string"},"status":{"type":"integer","format":"int32"},"title":{"type":"string"},"type":{"type":"string"}},"additionalProperties":{}},"Products.ProductByInventoryViewModel":{"type":"object","properties":{"has_variants":{"type":"boolean"},"id":{"type":"integer","format":"int64"},"inventory_id":{"type":"integer","format":"int32"},"variant_id":{"type":"integer","format":"int64"}},"additionalProperties":false},"Products.ProductViewModel":{"type":"object","properties":{"category":{"$ref":"#/components/schemas/Products.EnumViewModel"},"created_on":{"type":"string","format":"date-time"},"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"sub_category":{"$ref":"#/components/schemas/Products.EnumViewModel"},"type":{"type":"string"},"updated_on":{"type":"string","format":"date-time"},"user_id":{"type":"integer","format":"int64"},"variants":{"type":"array","items":{"$ref":"#/components/schemas/Products.VariantViewModel"}}},"additionalProperties":false},"Products.ProductViewModelArray":{"type":"array","items":{"$ref":"#/components/schemas/Products.ProductViewModel"}},"Products.Put.Api.Product.ProductId.ProductId.Integer":{"type":"integer","format":"int64"},"Products.Put.Api.Product.ProductId.Variants.ProductId.Integer":{"type":"integer","format":"int64"},"Products.Put.Api.V2.Variant.VariantId.Channel.Metadata.ChannelMetadataId.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Products.Put.Api.V2.Variant.VariantId.Channel.Metadata.ChannelMetadataId.ChannelMetadataId.Integer":{"type":"integer","format":"int64"},"Products.Put.Api.V2.Variant.VariantId.Channel.Metadata.ChannelMetadataId.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Put.Api.V2.Variant.VariantId.Channel.Metadata.ChannelMetadataId.Request.OneOf.AmazonChannelMetadataRequestModel.BaseChannelMetadataRequestModel.BigCommerceChannelMetadataRequestModel.ShopifyChannelMetadataRequestModel":{"oneOf":[{"$ref":"#/components/schemas/Products.AmazonChannelMetadataRequestModel"},{"$ref":"#/components/schemas/Products.BaseChannelMetadataRequestModel"},{"$ref":"#/components/schemas/Products.BigCommerceChannelMetadataRequestModel"},{"$ref":"#/components/schemas/Products.ShopifyChannelMetadataRequestModel"}],"example":{"asin":"string","channel_id":0,"currency":"string","fnsku":"string","fulfillment_channel":"string","id":0,"is_inventory_sync_enabled":true,"legacy_product_id":0,"platform":"string","platform_identifier":"string","platform_inventory_item_id":"string","price":0.1,"seller_sku":"string"}},"Products.Put.Api.V2.Variant.VariantId.Channel.Metadata.ChannelMetadataId.VariantId.Integer":{"type":"integer","format":"int64"},"Products.ReturnPreferencesRequestModel":{"type":"object","properties":{"backup_action_id":{"type":"integer","format":"int32"},"instructions":{"type":"string"},"primary_action_id":{"type":"integer","format":"int32"},"return_to_sender_backup_action_id":{"type":"integer","format":"int32"},"return_to_sender_primary_action_id":{"type":"integer","format":"int32"}},"additionalProperties":false},"Products.ReturnPreferencesViewModel":{"type":"object","properties":{"backup_action":{"$ref":"#/components/schemas/Products.EnumViewModel"},"instructions":{"type":"string"},"primary_action":{"$ref":"#/components/schemas/Products.EnumViewModel"},"return_to_sender_backup_action":{"$ref":"#/components/schemas/Products.EnumViewModel"},"return_to_sender_primary_action":{"$ref":"#/components/schemas/Products.EnumViewModel"}},"additionalProperties":false},"Products.SerialScanRequestModel":{"type":"object","properties":{"exact_character_length":{"type":"integer","format":"int32"},"is_enabled":{"type":"boolean"},"prefix":{"type":"string"},"suffix":{"type":"string"}},"additionalProperties":false},"Products.SerialScanViewModel":{"type":"object","properties":{"exact_character_length":{"type":"integer","format":"int32"},"is_enabled":{"type":"boolean"},"prefix":{"type":"string"},"suffix":{"type":"string"}},"additionalProperties":false},"Products.ShopifyChannelMetadataRequestModel":{"type":"object","allOf":[{"$ref":"#/components/schemas/Products.BaseChannelMetadataRequestModel"}],"properties":{"platform":{"type":"string","readOnly":true}},"additionalProperties":false,"description":"Shopify Sales Channel Information"},"Products.ShopifyChannelMetadataViewModel":{"type":"object","allOf":[{"$ref":"#/components/schemas/Products.ChannelMetadataViewModel"}],"additionalProperties":false},"Products.SubCategoryViewModel":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"status":{"type":"string"}},"additionalProperties":false},"Products.TaxonomyInformationViewModel":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"parent_id":{"type":"integer","format":"int32"},"parent_name":{"type":"string"},"path":{"type":"string"}},"additionalProperties":false},"Products.TaxonomyViewModel":{"type":"object","allOf":[{"$ref":"#/components/schemas/Products.BaseTaxonomyViewModel"}],"properties":{"children":{"type":"array","items":{"$ref":"#/components/schemas/Products.ChildTaxonomyViewModel"}},"parent":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/Products.BaseTaxonomyViewModel"},{"$ref":"#/components/schemas/Products.ChildTaxonomyViewModel"},{"$ref":"#/components/schemas/Products.TaxonomyViewModel"}]}},"additionalProperties":false},"Products.TaxonomyViewModelArray":{"type":"array","items":{"$ref":"#/components/schemas/Products.TaxonomyViewModel"}},"Products.UpdateProductRequestModel":{"type":"object","allOf":[{"$ref":"#/components/schemas/Products.BaseProductRequestModel"}],"properties":{"id":{"type":"integer","description":"Unique reference ID for the product","format":"int64"},"variants":{"type":"array","items":{"$ref":"#/components/schemas/Products.UpdateProductVariantRequestModel"},"description":"The variants of the product to updated. Products that are not multi-variant will only have one variant"}},"additionalProperties":false,"description":"The product to update"},"Products.UpdateProductRequestModelV3":{"type":"object","allOf":[{"$ref":"#/components/schemas/Products.BaseProductRequestModel"}],"properties":{"variants":{"type":"array","items":{"$ref":"#/components/schemas/Products.UpdateProductVariantRequestModelV3"}}},"additionalProperties":false,"description":"The product to update"},"Products.UpdateProductVariantRequestModel":{"type":"object","allOf":[{"$ref":"#/components/schemas/Products.BaseProductVariantRequestModel"}],"properties":{"id":{"type":"integer","format":"int64"}},"additionalProperties":false},"Products.UpdateProductVariantRequestModelArray":{"type":"array","items":{"$ref":"#/components/schemas/Products.UpdateProductVariantRequestModel"}},"Products.UpdateProductVariantRequestModelV3":{"type":"object","allOf":[{"$ref":"#/components/schemas/Products.UpdateProductVariantRequestModel"}],"properties":{"barcode_sticker_url":{"type":"string"}},"additionalProperties":false},"Products.UpdateViewRequestModel":{"type":"object","allOf":[{"$ref":"#/components/schemas/Products.BaseViewRequestModel"}],"properties":{"id":{"type":"integer","format":"int64"}},"additionalProperties":false},"Products.UpdateViewRequestModelArray":{"type":"array","items":{"$ref":"#/components/schemas/Products.UpdateViewRequestModel"}},"Products.VariantToMigrate":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"}},"additionalProperties":false},"Products.VariantViewModel":{"type":"object","allOf":[{"$ref":"#/components/schemas/Products.VariantViewModelBase"}],"properties":{"channel_metadata":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Products.ChannelMetadataViewModel"},{"$ref":"#/components/schemas/Products.AmazonChannelMetadataViewModel"},{"$ref":"#/components/schemas/Products.BigCommerceChannelMetadataViewModel"},{"$ref":"#/components/schemas/Products.ShopifyChannelMetadataViewModel"}]}}},"additionalProperties":false},"Products.VariantViewModelArray":{"type":"array","items":{"$ref":"#/components/schemas/Products.VariantViewModel"}},"Products.VariantViewModelBase":{"type":"object","properties":{"associated_bundles":{"type":"array","items":{"$ref":"#/components/schemas/Products.AssociatedBundlesViewModel"}},"barcode":{"type":"string"},"bundle_definition":{"type":"array","items":{"$ref":"#/components/schemas/Products.BundleDefinitionViewModel"}},"created_on":{"type":"string","format":"date-time"},"customs":{"$ref":"#/components/schemas/Products.CustomsViewModel"},"dimension":{"$ref":"#/components/schemas/Products.DimensionViewModel"},"fulfillment_settings":{"$ref":"#/components/schemas/Products.FulfillmentSettingsViewModel"},"gtin":{"type":"string"},"id":{"type":"integer","format":"int64"},"inventory":{"$ref":"#/components/schemas/Products.InventoryViewModel"},"is_digital":{"type":"boolean"},"lot_information":{"$ref":"#/components/schemas/Products.LotInformationViewModel"},"name":{"type":"string"},"packaging_material_type":{"$ref":"#/components/schemas/Products.EnumViewModel"},"packaging_requirement":{"$ref":"#/components/schemas/Products.EnumViewModel"},"return_preferences":{"$ref":"#/components/schemas/Products.ReturnPreferencesViewModel"},"sku":{"type":"string"},"status":{"type":"string"},"upc":{"type":"string"},"updated_on":{"type":"string","format":"date-time"},"weight":{"$ref":"#/components/schemas/Products.WeightViewModel"}},"additionalProperties":false},"Products.ViewResponseModel":{"type":"object","properties":{"column_definitions":{"type":"array","items":{"$ref":"#/components/schemas/Products.ColumnDefinitionModel"}},"created_on":{"type":"string","format":"date-time"},"filters":{"nullable":true},"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"order":{"type":"integer","format":"int32"},"sort":{"nullable":true},"updated_on":{"type":"string","format":"date-time"},"user_id":{"type":"integer","format":"int64"}},"additionalProperties":false},"Products.ViewResponseModelArray":{"type":"array","items":{"$ref":"#/components/schemas/Products.ViewResponseModel"}},"Products.WeightViewModel":{"type":"object","properties":{"unit":{"type":"string"},"weight":{"type":"number","format":"double"}},"additionalProperties":false},"Receiving.AddBoxItemToBoxModel":{"required":["inventory_id","quantity"],"type":"object","properties":{"inventory_id":{"type":"integer","format":"int32"},"lot_date":{"type":"string","format":"date-time"},"lot_number":{"type":"string"},"quantity":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},"additionalProperties":false},"Receiving.AddBoxToOrderModel":{"required":["box_items","tracking_number"],"type":"object","properties":{"box_items":{"type":"array","items":{"$ref":"#/components/schemas/Receiving.AddBoxItemToBoxModel"}},"tracking_number":{"minLength":1,"type":"string"}},"additionalProperties":false},"Receiving.AssignOrderToFulfillmentCenterModel":{"required":["id"],"type":"object","properties":{"id":{"type":"integer","format":"int32"}},"additionalProperties":false},"Receiving.BoxItemViewModel":{"type":"object","properties":{"inventory_id":{"type":"integer","description":"Unique identifier of the inventory item","format":"int32"},"lot_date":{"type":"string","description":"Expiration date of the item's lot","format":"date-time"},"lot_number":{"type":"string","description":"Lot number the item belongs to"},"quantity":{"type":"integer","description":"Quantity of the item included","format":"int32"},"received_quantity":{"type":"integer","description":"Quantity of the item that was received after processing the receiving order","format":"int32"},"stowed_quantity":{"type":"integer","description":"Quantity of the item that has been stowed","format":"int32"}},"additionalProperties":false,"description":"Information about an item contained inside a box as part of a receiving order"},"Receiving.BoxStatu":{"enum":["Awaiting","Arrived","Completed","Counting","Stowing","Cancelled"],"type":"string"},"Receiving.BoxStatus":{"enum":["Awaiting","Arrived","Completed","Counting","Stowing","Cancelled"],"type":"string"},"Receiving.BoxViewModel":{"type":"object","properties":{"arrived_date":{"type":"string","description":"Date the box arrived","format":"date-time"},"box_id":{"type":"integer","format":"int32"},"box_items":{"type":"array","items":{"$ref":"#/components/schemas/Receiving.BoxItemViewModel"},"description":"Information about the items included in the box"},"box_number":{"type":"integer","description":"The number of the box in the receiving order","format":"int32"},"box_status":{"$ref":"#/components/schemas/Receiving.BoxStatus"},"counting_started_date":{"type":"string","description":"Date counting of the box's inventory items started","format":"date-time"},"received_date":{"type":"string","description":"Date the box was received","format":"date-time"},"tracking_number":{"type":"string","description":"Tracking number of the box shipment","example":"860C8CDC8F0B4FC7AB69AC86C20539EC"}},"additionalProperties":false,"description":"Information about a box shipment included in a receiving order"},"Receiving.BoxViewModelArray":{"type":"array","items":{"$ref":"#/components/schemas/Receiving.BoxViewModel"}},"Receiving.CreateReceivingOrderModel":{"required":["box_packaging_type","boxes","expected_arrival_date","fulfillment_center","package_type"],"type":"object","properties":{"box_packaging_type":{"$ref":"#/components/schemas/Receiving.PackingType"},"boxes":{"type":"array","items":{"$ref":"#/components/schemas/Receiving.AddBoxToOrderModel"},"description":"Box shipments to be added to this receiving order"},"expected_arrival_date":{"type":"string","description":"Expected arrival date of all the box shipments in this receiving order","format":"date-time"},"fulfillment_center":{"$ref":"#/components/schemas/Receiving.AssignOrderToFulfillmentCenterModel"},"package_type":{"$ref":"#/components/schemas/Receiving.PackageType"},"purchase_order_number":{"type":"string","description":"Purchase order number for this receiving order"}},"additionalProperties":false,"description":"Information to create a new receiving order"},"Receiving.CreateReceivingOrderRequest":{"required":["box_packaging_type","boxes","expected_arrival_date","fulfillment_center","package_type"],"type":"object","properties":{"box_packaging_type":{"$ref":"#/components/schemas/Receiving.PackingType"},"boxes":{"type":"array","items":{"$ref":"#/components/schemas/Receiving.AddBoxToOrderModel"}},"expected_arrival_date":{"type":"string","format":"date-time"},"fulfillment_center":{"$ref":"#/components/schemas/Receiving.AssignOrderToFulfillmentCenterModel"},"package_type":{"$ref":"#/components/schemas/Receiving.PackageType"},"purchase_order_number":{"type":"string"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/Receiving.TagModel"}}},"additionalProperties":false},"Receiving.FulfillmentCenterViewModel":{"required":["address1","country","id","name","state","zip_code"],"type":"object","properties":{"address1":{"minLength":1,"type":"string"},"address2":{"type":"string"},"city":{"type":"string"},"country":{"minLength":1,"type":"string"},"email":{"type":"string"},"id":{"type":"integer","format":"int32"},"name":{"minLength":1,"type":"string"},"phone_number":{"type":"string"},"state":{"minLength":1,"type":"string"},"timezone":{"type":"string"},"zip_code":{"minLength":1,"type":"string"}},"additionalProperties":false},"Receiving.FulfillmentCenterViewModelArray":{"type":"array","items":{"$ref":"#/components/schemas/Receiving.FulfillmentCenterViewModel"}},"Receiving.Get.2.0.Receiving.CompletedEndDate.String":{"type":"string","format":"date-time"},"Receiving.Get.2.0.Receiving.CompletedStartDate.String":{"type":"string","format":"date-time"},"Receiving.Get.2.0.Receiving.ExternalSync.Boolean":{"type":"boolean"},"Receiving.Get.2.0.Receiving.FulfillmentCenterIds.IntegerArray":{"type":"array","items":{"type":"integer","format":"int32"}},"Receiving.Get.2.0.Receiving.IDs.IntegerArray":{"type":"array","items":{"type":"integer","format":"int32"}},"Receiving.Get.2.0.Receiving.Id.Boxes.Id.Integer":{"type":"integer","format":"int32"},"Receiving.Get.2.0.Receiving.Id.Boxes.Not.Found.OneOf.ValidationProblemDetail":{"oneOf":[{"$ref":"#/components/schemas/Receiving.ValidationProblemDetails"}]},"Receiving.Get.2.0.Receiving.Id.Boxes.Not.Found.OneOf.ValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Receiving.ValidationProblemDetails"}]},"Receiving.Get.2.0.Receiving.Id.Id.Integer":{"type":"integer","format":"int32"},"Receiving.Get.2.0.Receiving.Id.Labels.Bad.Request.OneOf.ValidationProblemDetail":{"oneOf":[{"$ref":"#/components/schemas/Receiving.ValidationProblemDetails"}]},"Receiving.Get.2.0.Receiving.Id.Labels.Bad.Request.OneOf.ValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Receiving.ValidationProblemDetails"}]},"Receiving.Get.2.0.Receiving.Id.Labels.Id.Integer":{"type":"integer","format":"int32"},"Receiving.Get.2.0.Receiving.Id.Labels.Not.Found.OneOf.ValidationProblemDetail":{"oneOf":[{"$ref":"#/components/schemas/Receiving.ValidationProblemDetails"}]},"Receiving.Get.2.0.Receiving.Id.Labels.Not.Found.OneOf.ValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Receiving.ValidationProblemDetails"}]},"Receiving.Get.2.0.Receiving.Id.Labels.OK.String":{"type":"string","format":"byte"},"Receiving.Get.2.0.Receiving.Id.Not.Found.OneOf.ValidationProblemDetail":{"oneOf":[{"$ref":"#/components/schemas/Receiving.ValidationProblemDetails"}]},"Receiving.Get.2.0.Receiving.Id.Not.Found.OneOf.ValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Receiving.ValidationProblemDetails"}]},"Receiving.Get.2.0.Receiving.InsertEndDate.String":{"type":"string","format":"date-time"},"Receiving.Get.2.0.Receiving.InsertStartDate.String":{"type":"string","format":"date-time"},"Receiving.Get.2.0.Receiving.Limit.Integer":{"type":"integer","format":"int32"},"Receiving.Get.2.0.Receiving.Not.Found.OneOf.ValidationProblemDetail":{"oneOf":[{"$ref":"#/components/schemas/Receiving.ValidationProblemDetails"}]},"Receiving.Get.2.0.Receiving.Not.Found.OneOf.ValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Receiving.ValidationProblemDetails"}]},"Receiving.Get.2.0.Receiving.OK.Next.Page.String":{"type":"string"},"Receiving.Get.2.0.Receiving.OK.Page.Number.Int":{"type":"integer"},"Receiving.Get.2.0.Receiving.OK.Page.Size.Int":{"type":"integer"},"Receiving.Get.2.0.Receiving.OK.Total.Count.Int":{"type":"integer"},"Receiving.Get.2.0.Receiving.OK.Total.Pages.Int":{"type":"integer"},"Receiving.Get.2.0.Receiving.Page.Integer":{"type":"integer","format":"int32"},"Receiving.Get.2.0.Receiving.PurchaseOrderNumbers.StringArray":{"type":"array","items":{"type":"string"}},"Receiving.Get.Api.Receiving.Authorization.String":{"type":"string"},"Receiving.Get.Api.Receiving.FulfillmentCenterIds.IntegerArray":{"type":"array","items":{"type":"integer","format":"int32"}},"Receiving.Get.Api.Receiving.IDs.IntegerArray":{"type":"array","items":{"type":"integer","format":"int32"}},"Receiving.Get.Api.Receiving.InsertEndDate.String":{"type":"string","format":"date-time"},"Receiving.Get.Api.Receiving.InsertStartDate.String":{"type":"string","format":"date-time"},"Receiving.Get.Api.Receiving.Limit.Integer":{"maximum":250,"minimum":1,"type":"integer","format":"int32"},"Receiving.Get.Api.Receiving.Page.Integer":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"},"Receiving.Get.Api.Receiving.PurchaseOrderNumbers.StringArray":{"type":"array","items":{"type":"string"}},"Receiving.InventoryQuantityViewModel":{"required":["expected_quantity","inventory_id","received_quantity","sku","stowed_quantity"],"type":"object","properties":{"expected_quantity":{"type":"integer","format":"int32"},"inventory_id":{"type":"integer","format":"int32"},"received_quantity":{"type":"integer","format":"int32"},"sku":{"minLength":1,"type":"string"},"stowed_quantity":{"type":"integer","format":"int32"}},"additionalProperties":false},"Receiving.PackageType":{"enum":["Package","Pallet","FloorLoadedContainer"],"type":"string","description":"\n\nPackage\n\nPallet\n\nFloorLoadedContainer","x-enumNames":["Package","Pallet","FloorLoadedContainer"]},"Receiving.PackingType":{"enum":["EverythingInOneBox","OneSkuPerBox","MultipleSkuPerBox"],"type":"string","description":"\n\nEverythingInOneBox\n\nOneSkuPerBox\n\nMultipleSkuPerBox","x-enumNames":["EverythingInOneBox","OneSkuPerBox","MultipleSkuPerBox"]},"Receiving.Post.2.0.Receiving.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Receiving.Post.2.0.Receiving.Id.Cancel.Id.Integer":{"type":"integer","format":"int32"},"Receiving.Post.2.0.Receiving.Id.Cancel.Not.Found.OneOf.ValidationProblemDetail":{"oneOf":[{"$ref":"#/components/schemas/Receiving.ValidationProblemDetails"}]},"Receiving.Post.2.0.Receiving.Id.Cancel.Not.Found.OneOf.ValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Receiving.ValidationProblemDetails"}]},"Receiving.Post.2.0.Receiving.Id.Cancel.Unprocessable.Entity.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Receiving.Post.2.0.Receiving.Not.Found.OneOf.ValidationProblemDetail":{"oneOf":[{"$ref":"#/components/schemas/Receiving.ValidationProblemDetails"}]},"Receiving.Post.2.0.Receiving.Not.Found.OneOf.ValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Receiving.ValidationProblemDetails"}]},"Receiving.Post.Api.Receiving.Authorization.String":{"type":"string"},"Receiving.Post.Api.Receiving.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Receiving.Post.Api.Receiving.Unprocessable.Entity.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Receiving.ProblemDetail":{"type":"object","properties":{"detail":{"type":"string"},"instance":{"type":"string"},"status":{"type":"integer","format":"int32"},"title":{"type":"string"},"type":{"type":"string"}},"additionalProperties":{}},"Receiving.ProblemDetails":{"type":"object","properties":{"detail":{"type":"string"},"instance":{"type":"string"},"status":{"type":"integer","format":"int32"},"title":{"type":"string"},"type":{"type":"string"}},"additionalProperties":{}},"Receiving.ReceivingStatu":{"enum":["Awaiting","Processing","Completed","Cancelled","Incomplete","Arrived","PartiallyArrived","PartiallyArrivedAtHub","ArrivedAtHub","ProcessingAtHub","InternalTransfer"],"type":"string"},"Receiving.ReceivingStatus":{"enum":["Awaiting","Processing","Completed","Cancelled","Incomplete","Arrived","PartiallyArrived","PartiallyArrivedAtHub","ArrivedAtHub","ProcessingAtHub","InternalTransfer"],"type":"string","description":"\n\nAwaiting\n\nProcessing\n\nCompleted\n\nCancelled\n\nIncomplete\n\nArrived\n\nPartiallyArrived\n\nPartiallyArrivedAtHub\n\nArrivedAtHub\n\nProcessingAtHub\n\nInternalTransfer","x-enumNames":["Awaiting","Processing","Completed","Cancelled","Incomplete","Arrived","PartiallyArrived","PartiallyArrivedAtHub","ArrivedAtHub","ProcessingAtHub","InternalTransfer"]},"Receiving.ReceivingStatusArray":{"type":"array","items":{"$ref":"#/components/schemas/Receiving.ReceivingStatus"}},"Receiving.TagModel":{"required":["name","value"],"type":"object","properties":{"name":{"maxLength":50,"minLength":1,"type":"string"},"value":{"maxLength":500,"minLength":1,"type":"string"}},"additionalProperties":false},"Receiving.V2.InventoryQuantityViewModel":{"type":"object","properties":{"expected_quantity":{"type":"integer","description":"Quantity of the inventory item submitted in the WRO","format":"int32"},"inventory_id":{"type":"integer","description":"ID of the inventory item","format":"int32"},"received_quantity":{"type":"integer","description":"Quantity of the inventory item received by the warehouse","format":"int32"},"sku":{"type":"string","description":"Sku of the inventory item"},"stowed_quantity":{"type":"integer","description":"Quantity of the inventory item stowed by the warehouse","format":"int32"}},"additionalProperties":false},"Receiving.V2.WarehouseReceivingOrderViewModel":{"type":"object","properties":{"box_labels_uri":{"type":"string","description":"URL to the packing slip to be included in each box shipment for this receiving order","example":"https://api.shipbob.com/1.0/receiving/1/labels"},"box_packaging_type":{"$ref":"#/components/schemas/Receiving.PackingType"},"expected_arrival_date":{"type":"string","description":"Expected date that all packages will have arrived","format":"date-time"},"fulfillment_center":{"$ref":"#/components/schemas/Receiving.FulfillmentCenterViewModel"},"id":{"type":"integer","description":"Unique id of the warehouse receiving order","format":"int32"},"insert_date":{"type":"string","description":"Insert date of the receiving order","format":"date-time"},"inventory_quantities":{"type":"array","items":{"$ref":"#/components/schemas/Receiving.V2.InventoryQuantityViewModel"},"description":"Inventory items and quantities within the WRO"},"last_updated_date":{"type":"string","description":"Last date the receiving order was updated","format":"date-time"},"package_type":{"$ref":"#/components/schemas/Receiving.PackageType"},"purchase_order_number":{"type":"string","description":"Purchase order number for a receiving order"},"status":{"$ref":"#/components/schemas/Receiving.ReceivingStatus"}},"additionalProperties":false},"Receiving.V2.WarehouseReceivingOrderViewModelArray":{"type":"array","items":{"$ref":"#/components/schemas/Receiving.V2.WarehouseReceivingOrderViewModel"}},"Receiving.ValidationProblemDetail":{"type":"object","properties":{"detail":{"type":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"readOnly":true},"instance":{"type":"string"},"status":{"type":"integer","format":"int32"},"title":{"type":"string"},"type":{"type":"string"}},"additionalProperties":{"type":"object","additionalProperties":false}},"Receiving.ValidationProblemDetails":{"type":"object","properties":{"detail":{"type":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"readOnly":true},"instance":{"type":"string"},"status":{"type":"integer","format":"int32"},"title":{"type":"string"},"type":{"type":"string"}},"additionalProperties":{"type":"object","additionalProperties":false}},"Receiving.WarehouseReceivingOrderViewModel":{"required":["box_labels_uri","id","insert_date","inventory_quantities"],"type":"object","properties":{"box_labels_uri":{"minLength":1,"type":"string"},"box_packaging_type":{"$ref":"#/components/schemas/Receiving.PackingType"},"expected_arrival_date":{"type":"string","format":"date-time"},"fulfillment_center":{"$ref":"#/components/schemas/Receiving.FulfillmentCenterViewModel"},"id":{"type":"integer","format":"int32"},"insert_date":{"type":"string","format":"date-time"},"inventory_quantities":{"type":"array","items":{"$ref":"#/components/schemas/Receiving.InventoryQuantityViewModel"}},"last_updated_date":{"type":"string","format":"date-time"},"package_type":{"$ref":"#/components/schemas/Receiving.PackageType"},"purchase_order_number":{"type":"string"},"status":{"$ref":"#/components/schemas/Receiving.ReceivingStatus"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/Receiving.TagModel"}}},"additionalProperties":false},"Receiving.WarehouseReceivingOrderViewModelArray":{"type":"array","items":{"$ref":"#/components/schemas/Receiving.WarehouseReceivingOrderViewModel"}},"Returns.ChannelInfoModel":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"}},"additionalProperties":false},"Returns.ChannelInfoViewModel":{"type":"object","properties":{"id":{"type":"integer","description":"Unique id of the channel","format":"int32"},"name":{"type":"string","description":"Name of the channel","example":"ShipBobs-Shopify-Store"}},"additionalProperties":false,"description":"Created by channel metadata"},"Returns.CreateReturnRequest":{"type":"object","properties":{"fulfillmentCenter":{"$ref":"#/components/schemas/Returns.Facility"},"inventory":{"type":"array","items":{"$ref":"#/components/schemas/Returns.ReturnInventory"}},"originalShipmentId":{"type":"integer","format":"int32"},"referenceId":{"type":"string"},"trackingNumber":{"type":"string"}},"additionalProperties":false},"Returns.CreateReturnViewModel":{"required":["fulfillment_center","inventory","reference_id"],"type":"object","properties":{"fulfillment_center":{"$ref":"#/components/schemas/Returns.FulfillmentCenterViewModel"},"inventory":{"minLength":1,"type":"array","items":{"$ref":"#/components/schemas/Returns.ReturnInventoryViewModel"},"description":"Array of inventory items being returned"},"original_shipment_id":{"type":"integer","description":"Shipment from which the items in the return originated","format":"int32","example":123456},"reference_id":{"maxLength":50,"type":"string","description":"Client-defined external unique identifier for the return order","example":"ShipBob_Return_123"},"tracking_number":{"maxLength":500,"type":"string","description":"Tracking number for the return shipment","example":"1Z9999999999999999"}},"additionalProperties":false},"Returns.Facility":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"}},"additionalProperties":false},"Returns.FulfillmentCenterModel":{"required":["id"],"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"}},"additionalProperties":false},"Returns.FulfillmentCenterViewModel":{"required":["id"],"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the fulfillment center","format":"int32"},"name":{"type":"string","description":"Name of the fulfillment center","example":"Cicero (IL)"}},"additionalProperties":false,"description":"Information about a fulfillment center"},"Returns.Get.1.0.Return.EndDate.String":{"type":"string","format":"date-time"},"Returns.Get.1.0.Return.FulfillmentCenterIds.IntegerArray":{"type":"array","items":{"type":"integer","format":"int32"}},"Returns.Get.1.0.Return.IDs.IntegerArray":{"type":"array","items":{"type":"integer","format":"int32"}},"Returns.Get.1.0.Return.Id.Statushistory.Id.Integer":{"type":"integer","format":"int32"},"Returns.Get.1.0.Return.Id.Statushistory.Not.Found.OneOf.ValidationProblemDetail":{"oneOf":[{"$ref":"#/components/schemas/Returns.ValidationProblemDetails"}]},"Returns.Get.1.0.Return.Id.Statushistory.Not.Found.OneOf.ValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Returns.ValidationProblemDetails"}]},"Returns.Get.1.0.Return.Id.Statushistory.Shipbob.Channel.Id.Integer":{"type":"integer","format":"int32"},"Returns.Get.1.0.Return.InventoryIds.IntegerArray":{"type":"array","items":{"type":"integer","format":"int32"}},"Returns.Get.1.0.Return.Limit.Integer":{"type":"integer","format":"int32"},"Returns.Get.1.0.Return.OK.Page.Number.Int":{"type":"integer","description":"Number of the current page","format":""},"Returns.Get.1.0.Return.OK.Page.Size.Int":{"type":"integer","description":"Number of results per page","format":""},"Returns.Get.1.0.Return.OK.Total.Count.Int":{"type":"integer","description":"Total number of results","format":""},"Returns.Get.1.0.Return.OK.Total.Pages.Int":{"type":"integer","description":"Total number of pages of results","format":""},"Returns.Get.1.0.Return.OriginalShipmentIds.IntegerArray":{"type":"array","items":{"type":"integer","format":"int32"}},"Returns.Get.1.0.Return.Page.Integer":{"type":"integer","format":"int32"},"Returns.Get.1.0.Return.ReferenceIds.StringArray":{"type":"array","items":{"type":"string"}},"Returns.Get.1.0.Return.Shipbob.Channel.Id.Integer":{"type":"integer","format":"int32"},"Returns.Get.1.0.Return.StartDate.String":{"type":"string","format":"date-time"},"Returns.Get.1.0.Return.TrackingNumbers.StringArray":{"type":"array","items":{"type":"string"}},"Returns.Get.Api.Public.Id.Api.Version.String":{"type":"string","default":"1.0"},"Returns.Get.Api.Public.Id.Id.Integer":{"type":"integer","format":"int32"},"Returns.Get.Api.Public.Id.Shipbob.Channel.Id.Integer":{"type":"integer","format":"int32"},"Returns.Get.Api.Return.Authorization.String":{"type":"string"},"Returns.Get.Api.Return.EndDate.String":{"type":"string","format":"date-time"},"Returns.Get.Api.Return.FulfillmentCenterIds.IntegerArray":{"type":"array","items":{"type":"integer","format":"int32"}},"Returns.Get.Api.Return.IDs.IntegerArray":{"type":"array","items":{"type":"integer","format":"int32"}},"Returns.Get.Api.Return.Id.Authorization.String":{"type":"string"},"Returns.Get.Api.Return.Id.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Returns.Get.Api.Return.Id.Id.Integer":{"type":"integer","format":"int32"},"Returns.Get.Api.Return.Id.Shipbob.Channel.Id.Integer":{"type":"integer","format":"int32"},"Returns.Get.Api.Return.InventoryIds.IntegerArray":{"type":"array","items":{"type":"integer","format":"int32"}},"Returns.Get.Api.Return.Limit.Integer":{"maximum":250,"minimum":1,"type":"integer","format":"int32"},"Returns.Get.Api.Return.OK.Next.Page.String":{"type":"string","description":"The href of the next page of results, if there is a next page","format":""},"Returns.Get.Api.Return.OK.Page.Number.Int":{"type":"integer","description":"Number of the current page","format":""},"Returns.Get.Api.Return.OK.Page.Size.Int":{"type":"integer","description":"Number of results per page","format":""},"Returns.Get.Api.Return.OK.Total.Count.Int":{"type":"integer","description":"Total number of results","format":""},"Returns.Get.Api.Return.OK.Total.Pages.Int":{"type":"integer","description":"Total number of pages of results","format":""},"Returns.Get.Api.Return.OriginalShipmentIds.IntegerArray":{"type":"array","items":{"type":"integer","format":"int32"}},"Returns.Get.Api.Return.Page.Integer":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32"},"Returns.Get.Api.Return.ReferenceIds.StringArray":{"type":"array","items":{"type":"string"}},"Returns.Get.Api.Return.Shipbob.Channel.Id.Integer":{"type":"integer","format":"int32"},"Returns.Get.Api.Return.StartDate.String":{"type":"string","format":"date-time"},"Returns.Get.Api.Return.TrackingNumbers.StringArray":{"type":"array","items":{"type":"string"}},"Returns.Get.Api.V2.Public.Search.Cursor.Integer":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"},"Returns.Get.Api.V2.Public.Search.End.Date.String":{"type":"string","format":"date-time"},"Returns.Get.Api.V2.Public.Search.Fulfillment.Center.Ids.String":{"type":"string"},"Returns.Get.Api.V2.Public.Search.Ids.String":{"type":"string"},"Returns.Get.Api.V2.Public.Search.Inventory.Ids.String":{"type":"string"},"Returns.Get.Api.V2.Public.Search.Limit.Integer":{"type":"integer","format":"int32"},"Returns.Get.Api.V2.Public.Search.Original.Shipment.Ids.String":{"type":"string"},"Returns.Get.Api.V2.Public.Search.Reference.Ids.String":{"type":"string"},"Returns.Get.Api.V2.Public.Search.Return.Actions.String":{"type":"string"},"Returns.Get.Api.V2.Public.Search.Return.Types.String":{"type":"string"},"Returns.Get.Api.V2.Public.Search.Shipbob.Channel.Id.Integer":{"type":"integer","format":"int32"},"Returns.Get.Api.V2.Public.Search.Sort.By.String":{"type":"string"},"Returns.Get.Api.V2.Public.Search.Start.Date.String":{"type":"string","format":"date-time"},"Returns.Get.Api.V2.Public.Search.Status.String":{"type":"string"},"Returns.Get.Api.V2.Public.Search.Store.Order.Ids.String":{"type":"string"},"Returns.Get.Api.V2.Public.Search.Tracking.Numbers.String":{"type":"string"},"Returns.InventoryItemViewModel":{"type":"object","properties":{"action_requested":{"$ref":"#/components/schemas/Returns.ReturnActionRequestedViewModel"},"action_taken":{"type":"array","items":{"$ref":"#/components/schemas/Returns.ReturnActionTakenViewModel"}},"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"quantity":{"type":"integer","format":"int32"}},"additionalProperties":false},"Returns.LotInformationViewModel":{"type":"object","properties":{"expiration_date":{"type":"string","format":"date-time"},"lot_number":{"type":"string"},"quantity_processed":{"type":"integer","format":"int32"}},"additionalProperties":false},"Returns.Post.1.0.Return.Id.Cancel.Id.Integer":{"type":"integer","format":"int32"},"Returns.Post.1.0.Return.Id.Cancel.Not.Found.OneOf.ValidationProblemDetail":{"oneOf":[{"$ref":"#/components/schemas/Returns.ValidationProblemDetails"}]},"Returns.Post.1.0.Return.Id.Cancel.Not.Found.OneOf.ValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Returns.ValidationProblemDetails"}]},"Returns.Post.1.0.Return.Id.Cancel.Shipbob.Channel.Id.Integer":{"type":"integer","format":"int32"},"Returns.Post.1.0.Return.Id.Cancel.Unprocessable.Entity.OneOf.ValidationProblemDetail":{"oneOf":[{"$ref":"#/components/schemas/Returns.ValidationProblemDetails"}]},"Returns.Post.1.0.Return.Id.Cancel.Unprocessable.Entity.OneOf.ValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Returns.ValidationProblemDetails"}]},"Returns.Post.Api.Return.Authorization.String":{"type":"string"},"Returns.Post.Api.Return.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Returns.Post.Api.Return.Id.Cancel.Authorization.String":{"type":"string"},"Returns.Post.Api.Return.Id.Cancel.Id.Integer":{"type":"integer","format":"int32"},"Returns.Post.Api.Return.Id.Cancel.Shipbob.Channel.Id.Integer":{"type":"integer","format":"int32"},"Returns.Post.Api.Return.Shipbob.Channel.Id.Integer":{"type":"integer","format":"int32"},"Returns.Post.Api.Return.Unprocessable.Entity.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Returns.Post.Api.V1.Public.Create.CreationSourceId.Integer":{"type":"integer","format":"int32","default":3},"Returns.Post.Api.V1.Public.Create.Shipbob.Channel.Id.Integer":{"type":"integer","format":"int32"},"Returns.ProblemDetail":{"type":"object","properties":{"detail":{"type":"string"},"instance":{"type":"string"},"status":{"type":"integer","format":"int32"},"title":{"type":"string"},"type":{"type":"string"}},"additionalProperties":{}},"Returns.ProblemDetails":{"type":"object","properties":{"detail":{"type":"string"},"instance":{"type":"string"},"status":{"type":"integer","format":"int32"},"title":{"type":"string"},"type":{"type":"string"}},"additionalProperties":{}},"Returns.Put.1.0.Return.Id.Bad.Request.OneOf.ValidationProblemDetail":{"oneOf":[{"$ref":"#/components/schemas/Returns.ValidationProblemDetails"}]},"Returns.Put.1.0.Return.Id.Bad.Request.OneOf.ValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Returns.ValidationProblemDetails"}]},"Returns.Put.1.0.Return.Id.Id.Integer":{"type":"integer","format":"int32"},"Returns.Put.1.0.Return.Id.Shipbob.Channel.Id.Integer":{"type":"integer","format":"int32"},"Returns.Put.1.0.Return.Id.Unprocessable.Entity.OneOf.ValidationProblemDetail":{"oneOf":[{"$ref":"#/components/schemas/Returns.ValidationProblemDetails"}]},"Returns.Put.1.0.Return.Id.Unprocessable.Entity.OneOf.ValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Returns.ValidationProblemDetails"}]},"Returns.Put.Api.Return.Id.Authorization.String":{"type":"string"},"Returns.Put.Api.Return.Id.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Returns.Put.Api.Return.Id.Id.Integer":{"type":"integer","format":"int32"},"Returns.Put.Api.Return.Id.Shipbob.Channel.Id.Integer":{"type":"integer","format":"int32"},"Returns.Put.Api.Return.Id.Unprocessable.Entity.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Returns.ReturnActi":{"enum":[0,1,2,3],"type":"integer","format":"int32"},"Returns.ReturnAction":{"enum":[0,1,2,3],"type":"integer","format":"int32"},"Returns.ReturnActionRequestedViewModel":{"type":"object","properties":{"action":{"$ref":"#/components/schemas/Returns.ReturnAction"},"action_type":{"$ref":"#/components/schemas/Returns.ReturnActionSource"},"instructions":{"type":"string"}},"additionalProperties":false},"Returns.ReturnActionSource":{"enum":["InventoryDefault","Override"],"type":"string","description":"\n\nInventoryDefault\n\nOverride","x-enumNames":["InventoryDefault","Override"]},"Returns.ReturnActionTakenViewModel":{"type":"object","properties":{"action":{"$ref":"#/components/schemas/Returns.ReturnAction"},"action_reason":{"type":"string","description":"Reason the given action was taken"},"lot_information":{"type":"array","items":{"$ref":"#/components/schemas/Returns.LotInformationViewModel"}},"quantity_processed":{"maximum":2147483647,"minimum":1,"type":"integer","description":"Quantity of inventory processed with the taken action","format":"int32"}},"additionalProperties":false},"Returns.ReturnInventory":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"lotDate":{"type":"string","format":"date-time"},"lotNumber":{"type":"string"},"quantity":{"type":"integer","format":"int32"},"requestedAction":{"$ref":"#/components/schemas/Returns.ReturnAction"}},"additionalProperties":false},"Returns.ReturnInventoryRequest":{"required":["id","quantity"],"type":"object","properties":{"id":{"type":"integer","format":"int32"},"quantity":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"},"requested_action":{"$ref":"#/components/schemas/Returns.ReturnAction"}},"additionalProperties":false},"Returns.ReturnInventoryViewModel":{"required":["id","quantity"],"type":"object","properties":{"id":{"type":"integer","description":"ID of the inventory item to return","format":"int32","example":111222},"quantity":{"maximum":2147483647,"minimum":1,"type":"integer","description":"Quantity of the returned inventory item in the return","format":"int32","example":1},"requested_action":{"$ref":"#/components/schemas/Returns.ReturnAction"}},"additionalProperties":false},"Returns.ReturnOrderStatusHistoryViewModel":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/Returns.ReturnStatus"},"time_stamp":{"type":"string","description":"Date this corresponding return order status was created","format":"date-time"}},"additionalProperties":false},"Returns.ReturnOrderStatusHistoryViewModelArray":{"type":"array","items":{"$ref":"#/components/schemas/Returns.ReturnOrderStatusHistoryViewModel"}},"Returns.ReturnOrderViewModel":{"type":"object","properties":{"channel":{"$ref":"#/components/schemas/Returns.ChannelInfoModel"},"completed_date":{"type":"string","format":"date-time"},"customer_name":{"type":"string"},"fulfillment_center":{"$ref":"#/components/schemas/Returns.FulfillmentCenterModel"},"id":{"type":"integer","format":"int32"},"insert_date":{"type":"string","format":"date-time"},"inventory":{"type":"array","items":{"$ref":"#/components/schemas/Returns.InventoryItemViewModel"}},"invoice_amount":{"type":"number","format":"double"},"original_shipment_id":{"type":"integer","format":"int32"},"reference_id":{"type":"string"},"return_type":{"$ref":"#/components/schemas/Returns.ReturnType"},"status":{"$ref":"#/components/schemas/Returns.ReturnStatus"},"store_order_id":{"type":"string"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/Returns.TagModel"}},"tracking_number":{"type":"string"},"transactions":{"type":"array","items":{"$ref":"#/components/schemas/Returns.TransactionViewModel"}}},"additionalProperties":false},"Returns.ReturnOrderViewModelArray":{"type":"array","items":{"$ref":"#/components/schemas/Returns.ReturnOrderViewModel"}},"Returns.ReturnStatu":{"enum":["AwaitingArrival","Arrived","Processing","Completed","Cancelled"],"type":"string"},"Returns.ReturnStatus":{"enum":["AwaitingArrival","Arrived","Processing","Completed","Cancelled"],"type":"string","description":"\n\nAwaitingArrival\n\nArrived\n\nProcessing\n\nCompleted\n\nCancelled","x-enumNames":["AwaitingArrival","Arrived","Processing","Completed","Cancelled"]},"Returns.ReturnStatusArray":{"type":"array","items":{"$ref":"#/components/schemas/Returns.ReturnStatus"}},"Returns.ReturnType":{"enum":["Regular","ReturnToSender"],"type":"string","description":"\n\nRegular\n\nReturnToSender","x-enumNames":["Regular","ReturnToSender"]},"Returns.SortOrder":{"enum":[0,1],"type":"integer","format":"int32"},"Returns.TagModel":{"required":["name","value"],"type":"object","properties":{"name":{"maxLength":50,"minLength":1,"type":"string"},"value":{"maxLength":500,"minLength":1,"type":"string"}},"additionalProperties":false},"Returns.TransactionLogSource":{"enum":["ReturnLabelInvoice","ReturnProcessingFee","ReturnToSenderFee"],"type":"string","description":"\n\nReturnLabelInvoice\n\nReturnProcessingFee\n\nReturnToSenderFee","x-enumNames":["ReturnLabelInvoice","ReturnProcessingFee","ReturnToSenderFee"]},"Returns.TransactionViewModel":{"type":"object","properties":{"amount":{"type":"number","format":"double"},"transaction_type":{"$ref":"#/components/schemas/Returns.TransactionLogSource"}},"additionalProperties":false},"Returns.ValidationProblemDetail":{"type":"object","properties":{"detail":{"type":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"readOnly":true},"extensions":{"type":"object","additionalProperties":{"type":"object","additionalProperties":false},"readOnly":true},"instance":{"type":"string"},"status":{"type":"integer","format":"int32"},"title":{"type":"string"},"type":{"type":"string"}},"additionalProperties":false},"Returns.ValidationProblemDetails":{"type":"object","properties":{"detail":{"type":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"readOnly":true},"extensions":{"type":"object","additionalProperties":{"type":"object","additionalProperties":false},"readOnly":true},"instance":{"type":"string"},"status":{"type":"integer","format":"int32"},"title":{"type":"string"},"type":{"type":"string"}},"additionalProperties":false},"TriggerSync.Post.Api.Linnworks.TriggerSync.Bad.Request.String":{"type":"string"},"TriggerSync.Post.Api.Linnworks.TriggerSync.Forbidden.String":{"type":"string"},"TriggerSync.Post.Api.Linnworks.TriggerSync.Unauthorized.String":{"type":"string"},"TriggerSync.fcToWHMapping":{"type":"object","properties":{"linnworks_locations":{"type":"string"},"shipbob_fullfilment_center":{"type":"string"}}},"TriggerSync.integrationRequest_linnworksConfig":{"required":["secrets","config","tenantName"],"type":"object","properties":{"config":{"$ref":"#/components/schemas/TriggerSync.linnworksConfig"},"secrets":{"$ref":"#/components/schemas/TriggerSync.integrationSecret"},"tenantName":{"minLength":1,"type":"string"}}},"TriggerSync.integrationSecret":{"required":["shipBobToken","integrationToken"],"type":"object","properties":{"integrationToken":{"minLength":1,"type":"string"},"shipBobToken":{"minLength":1,"type":"string"}}},"TriggerSync.integrationSuccessResponse":{"type":"object","properties":{"actionTaken":{"enum":[0,1,2],"type":"integer","format":"int32","default":0},"masterSyncId":{"type":"integer","format":"int64"},"requestId":{"type":"string","format":"uuid"}}},"TriggerSync.linnworksConfig":{"required":["linnworksApiUrl","shipBobApiUrl","trackingSync","orderSync","inventorySync","productSync","lookBackDays","startShippingDate"],"type":"object","properties":{"allowedHeadersForLogging":{"type":"string"},"confirmFulfillmentForProcessedOrders":{"type":"boolean"},"enableLinnworksTagCreation":{"type":"boolean"},"fcToWHMap":{"type":"array","items":{"$ref":"#/components/schemas/TriggerSync.fcToWHMapping"}},"inventorySync":{"type":"boolean"},"linnworksApiUrl":{"minLength":1,"type":"string"},"linnworksAvailableLocationsSelected":{"type":"array","items":{"type":"string"}},"logErrorRequestAndResponseData":{"type":"boolean"},"logRequestResponseHeader":{"type":"boolean"},"lookBackDays":{"type":"integer","format":"int32"},"markOrdersAsProcessed":{"type":"boolean"},"maxConcurrentRequests":{"type":"integer","format":"int32"},"orderSync":{"type":"boolean"},"productSync":{"type":"boolean"},"reconciliationSync":{"type":"boolean"},"shipBobApiUrl":{"minLength":1,"type":"string"},"startShippingDate":{"minLength":1,"type":"string"},"syncByDelegation":{"type":"boolean"},"syncPostalService":{"type":"boolean"},"trackingSync":{"type":"boolean"},"trackingSyncBatchSize":{"type":"integer","format":"int32"}}},"Webhooks.Create.WebhookViewModel":{"type":"object","properties":{"created_at":{"type":"string","description":"Timestamp the webhook subscription was created","format":"date-time"},"id":{"type":"integer","description":"ID of the webhook subscription","format":"int32","example":12345},"subscription_url":{"type":"string","description":"URL subscription events will be posted to","format":"uri"},"topic":{"$ref":"#/components/schemas/Webhooks.Topics"}},"additionalProperties":false},"Webhooks.CreateWebhookSubscriptionModel":{"required":["subscription_url","topic"],"type":"object","properties":{"subscription_url":{"type":"string","description":"URL we will call when an event matching the subscription topic is raised. Must have ssl enabled (https) and accept POST requests with content type of application/json","format":"uri","example":"https://mywebsite.com/shipbob/handler"},"topic":{"$ref":"#/components/schemas/Webhooks.Topics"}},"additionalProperties":false},"Webhooks.Delete.1.0.Webhook.Id.Id.Integer":{"type":"integer","description":"","format":"int32"},"Webhooks.Delete.1.0.Webhook.Id.Not.Found.OneOf.HttpValidationProblemDetail":{"oneOf":[{"$ref":"#/components/schemas/Webhooks.HttpValidationProblemDetails"}]},"Webhooks.Delete.1.0.Webhook.Id.Not.Found.OneOf.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Webhooks.HttpValidationProblemDetails"}]},"Webhooks.Get.1.0.Internal.Webhook.ChannelId.Integer":{"type":"integer","description":"Optional channel id of the webhooks requested","format":"int32"},"Webhooks.Get.1.0.Internal.Webhook.Limit.Integer":{"maximum":250,"minimum":1,"type":"integer","description":"Amount of Webhooks per page to request","format":"int32"},"Webhooks.Get.1.0.Internal.Webhook.Page.Integer":{"maximum":2147483647,"minimum":0,"type":"integer","description":"Page of Webhooks to get","format":"int32"},"Webhooks.Get.1.0.Internal.Webhook.UserId.Integer":{"type":"integer","description":"User Id of the webhooks requested","format":"int32"},"Webhooks.Get.1.0.Webhook.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Webhooks.Get.1.0.Webhook.Limit.Integer":{"maximum":250,"minimum":1,"type":"integer","description":"Amount of Webhooks per page to request","format":"int32"},"Webhooks.Get.1.0.Webhook.OK.Next.Page.String":{"type":"string","description":"The href of the next page of results, if there is a next page","format":""},"Webhooks.Get.1.0.Webhook.OK.Page.Number.Int":{"type":"integer","description":"Number of the current page","format":""},"Webhooks.Get.1.0.Webhook.OK.Page.Number.Integer":{"type":"integer","description":"Number of the current page","format":""},"Webhooks.Get.1.0.Webhook.OK.Page.Size.Int":{"type":"integer","description":"Number of results per page","format":""},"Webhooks.Get.1.0.Webhook.OK.Page.Size.Integer":{"type":"integer","description":"Number of results per page","format":""},"Webhooks.Get.1.0.Webhook.OK.Total.Count.Int":{"type":"integer","description":"Total number of results","format":""},"Webhooks.Get.1.0.Webhook.OK.Total.Count.Integer":{"type":"integer","description":"Total number of results","format":""},"Webhooks.Get.1.0.Webhook.OK.Total.Pages.Int":{"type":"integer","description":"Total number of pages of results","format":""},"Webhooks.Get.1.0.Webhook.OK.Total.Pages.Integer":{"type":"integer","description":"Total number of pages of results","format":""},"Webhooks.Get.1.0.Webhook.Page.Integer":{"maximum":2147483647,"minimum":0,"type":"integer","description":"Page of Webhooks to get","format":"int32"},"Webhooks.HttpValidationProblemDetail":{"allOf":[{"type":"object","properties":{"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"additionalProperties":false}]},"Webhooks.HttpValidationProblemDetails":{"allOf":[{"type":"object","properties":{"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"additionalProperties":false}]},"Webhooks.Post.1.0.Webhook.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Webhooks.Post.1.0.Webhook.Shipbob.Channel.Id.Integer":{"type":"integer","description":"","format":"int32"},"Webhooks.Post.1.0.Webhook.Unprocessable.Entity.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Webhooks.ProblemDetail":{"required":["$type"],"type":"object","properties":{"$type":{"type":"string"},"detail":{"type":"string"},"extensions":{"type":"object","additionalProperties":{"type":"object","additionalProperties":false}},"instance":{"type":"string"},"status":{"type":"integer","format":"int32"},"title":{"type":"string"},"type":{"type":"string"}},"additionalProperties":false},"Webhooks.ProblemDetails":{"required":["$type"],"type":"object","properties":{"$type":{"type":"string"},"detail":{"type":"string"},"extensions":{"type":"object","additionalProperties":{"type":"object","additionalProperties":false}},"instance":{"type":"string"},"status":{"type":"integer","format":"int32"},"title":{"type":"string"},"type":{"type":"string"}},"additionalProperties":false},"Webhooks.Topic":{"enum":["order_shipped","shipment_delivered","shipment_exception","shipment_onhold","shipment_cancelled"],"type":"string"},"Webhooks.Topics":{"enum":["order_shipped","shipment_delivered","shipment_exception","shipment_onhold","shipment_cancelled"],"type":"string"},"Webhooks.WebhookViewModel":{"type":"object","properties":{"created_at":{"type":"string","description":"Timestamp the webhook subscription was created","format":"date-time"},"enabled":{"type":"boolean","description":"Indicates if the webhook subscription is enabled or not"},"id":{"type":"integer","description":"ID of the webhook subscription","format":"int32","example":12345},"subscription_url":{"type":"string","description":"URL subscription events will be posted to","format":"uri"},"topic":{"$ref":"#/components/schemas/Webhooks.Topics"}},"additionalProperties":false},"Webhooks.WebhookViewModelArray":{"type":"array","items":{"$ref":"#/components/schemas/Webhooks.WebhookViewModel"}}},"securitySchemes":{"PAT":{"type":"http","scheme":"bearer","bearerFormat":"PAT","description":"Authentication using Personal Access Token (PAT) token"},"OAuth2":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://auth.shipbob.com/connect/authorize","tokenUrl":"https://auth.shipbob.com/connect/token","scopes":{"channels_read":"Read channel metadata","channels_write":"Write channel metadata","inventory_read":"Access inventory read operations","inventory_write":"Access inventory write operations","orders_read":"Access orders read operations","orders_write":"Access orders write operations","products_read":"Access products read operations","products_write":"Access products write operations","receiving_read":"Access receiving read operations","receiving_write":"Access receiving write operations","returns_read":"Access returns read operations","returns_write":"Access returns write operations","webhooks_read":"Access webhooks read operations","webhooks_write":"Access webhooks write operations","locations_read":"Access locations read operations","tracking_read":"Access tracking read operations"}}},"description":"OAuth2 authentication using JWT tokens"}}}}