{"openapi":"3.0.0","x-mcp":{"enabled":true},"info":{"title":"ShipBob Developer API (Experimental)","version":""},"servers":[{"url":"https://api.shipbob.com"},{"url":"https://sandbox-api.shipbob.com"}],"paths":{"/Experimental/channel:search":{"post":{"summary":"  Search channels\n","description":"  Search channels based on filters\n","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Channels.v2.ChannelSearchViewModel"},"examples":{"default":{"summary":"","description":"","value":{"items":[{"application_name":"string","id":0,"name":"string","scopes":["string"]}],"next":"string","prev":"string","total_records":0}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Channels.Post.Api.V2.Channel.Search.Bad.Request.Object"},"examples":{"default":{"summary":"","description":"","value":{"property1":["string"],"property2":["string"]}}}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"requestBody":{"x-name":"channels.v2.ChannelsV2SearchRequest","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Channels.v2.ChannelsV2SearchRequest"},"examples":{"default":{"summary":"","description":"","value":{"cursor":"string","records_per_page":0,"search_filters":{"channel_ids":[0],"channel_names":["string"]}}}}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Channels"]}},"/Experimental/receiving/:set-external-sync":{"post":{"summary":"Set ExternalSync flag for Wros\n","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"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receiving.Post.2.0.Receiving.Set.External.Sync.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"}},"requestBody":{"x-name":"receiving.UpdateExternalSyncModel","description":"The list of wro ids and a flag to enable external sync","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receiving.UpdateExternalSyncModel"},"examples":{"default":{"summary":"","description":"","value":{"ids":[0],"is_external_sync":true}}}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Receiving"]}},"/Experimental/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","required":true,"description":"The ID of the variant to remove the metadata from\n","schema":{"type":"string","format":"int64"}},{"name":"channelMetadataId","in":"path","required":true,"description":"The ID of the channel metadata record to delete\n","schema":{"type":"string","format":"int64"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.VariantViewModelV5"},"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"}],"barcodes":[{"sticker_url":"string","value":"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.Delete.Api.V5.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.Delete.Api.V5.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"}}}}}}},"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","required":true,"description":"The ID of the variant to update the metadata from\n","schema":{"type":"string","format":"int64"}},{"name":"channelMetadataId","in":"path","required":true,"description":"The ID of the channel metadata record to update\n","schema":{"type":"string","format":"int64"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.VariantViewModelV5"},"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"}],"barcodes":[{"sticker_url":"string","value":"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.V5.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.V5.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":{"x-name":"products.Put.Api.V5.Variant.VariantId.Channel.Metadata.ChannelMetadataId.Request.OneOf.AmazonChannelMetadataRequestModel.BaseChannelMetadataRequestModel.BigCommerceChannelMetadataRequestModel.ShopifyChannelMetadataRequestModel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.Put.Api.V5.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"]}},"/Experimental/variant/{variantId}/channel-metadata":{"post":{"summary":"Create a new Channel Metadata Entry for a given Variant\n","parameters":[{"name":"variantId","in":"path","required":true,"description":"","schema":{"type":"string","format":"int64"}}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.ProductViewModelV5"},"examples":{"default":{"summary":"","description":"","value":{"created_on":"2019-08-24T14:15:22+00:00","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"}],"barcodes":[{"sticker_url":"string","value":"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":{"x-name":"products.Post.Api.V5.Variant.VariantId.Channel.Metadata.Request.OneOf.AmazonChannelMetadataRequestModel.BaseChannelMetadataRequestModel.BigCommerceChannelMetadataRequestModel.ShopifyChannelMetadataRequestModel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.Post.Api.V5.Variant.VariantId.Channel.Metadata.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"]}},"/Experimental/product:moveVariants":{"post":{"summary":"Migrates existing variants to a new product\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"},"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}}]}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.Post.Api.V5.Product.MoveVariants.Bad.Request.Object"},"examples":{"default":{"summary":"","description":"","value":{"property1":["string"],"property2":["string"]}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.Post.Api.V5.Product.MoveVariants.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":{"x-name":"products.MigrateVariantRequestModel","description":"Migration definition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.MigrateVariantRequestModel"},"examples":{"default":{"summary":"","description":"","value":{"category_id":0,"name":"string","product_id":0,"sub_category_id":0,"taxonomy_id":0,"variants":[{"id":0,"name":"string"}]}}}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Products"]}},"/Experimental/packaging-requirement":{"get":{"summary":"Gets 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"}],"applicable_taxonomy":["string"],"description":"string","id":0,"name":"string"}]}}}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Products"]}},"/Experimental/taxonomy/{id}":{"get":{"summary":"  Gets Taxonomy by Id\n","parameters":[{"name":"id","in":"path","required":true,"description":"","schema":{"type":"string","format":"int32"}}],"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.V5.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.V5.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.V5.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"]}},"/Experimental/taxonomy":{"get":{"summary":"  Gets Taxonomy\n","parameters":[{"name":"search","in":"query","description":"","schema":{"type":"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.V5.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.V5.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"]}},"/Experimental/product/{productId}:moveVariants":{"post":{"summary":"Migrates variants to existing product\n","parameters":[{"name":"productId","in":"path","required":true,"description":"","schema":{"type":"string","format":"int64"}}],"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"},"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}}]}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.Post.Api.V5.Product.ProductId.MoveVariants.Bad.Request.Object"},"examples":{"default":{"summary":"","description":"","value":{"property1":["string"],"property2":["string"]}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.Post.Api.V5.Product.ProductId.MoveVariants.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":{"x-name":"products.MigrateVariantRequestModel","description":"Migration definition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.MigrateVariantRequestModel"},"examples":{"default":{"summary":"","description":"","value":{"category_id":0,"name":"string","product_id":0,"sub_category_id":0,"taxonomy_id":0,"variants":[{"id":0,"name":"string"}]}}}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Products"]}},"/Experimental/variant/{variantId}:convertToBundle":{"post":{"summary":"Add new product variants to a product\n","parameters":[{"name":"variantId","in":"path","required":true,"description":"","schema":{"type":"string","format":"int64"}}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.ProductViewModelV5"},"examples":{"default":{"summary":"","description":"","value":{"created_on":"2019-08-24T14:15:22+00:00","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"}],"barcodes":[{"sticker_url":"string","value":"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":{"x-name":"products.ConvertVariantToBundleRequest","description":"The variant request that is to be converted to bundle","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.ConvertVariantToBundleRequest"},"examples":{"default":{"summary":"","description":"","value":{"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"}],"name":"string","sku":"string"}}}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Products"]}},"/Experimental/product/{productId}":{"delete":{"summary":"Deletes Bundle and removes associations to related products\n","parameters":[{"name":"productId","in":"path","required":true,"description":"The product identifier\n","schema":{"type":"string","format":"int64"}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.Delete.Api.V5.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.Delete.Api.V5.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","required":true,"description":"The product identifier\n","schema":{"type":"string","format":"int64"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.ProductViewModelV5"},"examples":{"default":{"summary":"","description":"","value":{"created_on":"2019-08-24T14:15:22+00:00","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"}],"barcodes":[{"sticker_url":"string","value":"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":{"x-name":"products.UpdateProductRequestModelV5","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.UpdateProductRequestModelV5"},"examples":{"default":{"summary":"","description":"","value":{"id":0,"name":"string","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},"barcodes":[{"sticker_url":"string","value":"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"]},"get":{"summary":"  Gets Product by Id\n","parameters":[{"name":"productId","in":"path","required":true,"description":"","schema":{"type":"string","format":"int64"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.ProductViewModelV5"},"examples":{"default":{"summary":"","description":"","value":{"created_on":"2019-08-24T14:15:22+00:00","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"}],"barcodes":[{"sticker_url":"string","value":"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.Get.Api.V5.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.V5.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"]}},"/Experimental/variant/{variantId}:merge":{"post":{"summary":"Used to merge two or more variants together\n","parameters":[{"name":"variantId","in":"path","required":true,"description":"The ID of the variant to use as the merge target\n","schema":{"type":"string","format":"int64"}}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.ProductViewModelV5"},"examples":{"default":{"summary":"","description":"","value":{"created_on":"2019-08-24T14:15:22+00:00","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"}],"barcodes":[{"sticker_url":"string","value":"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":{"x-name":"products.MergeVariantRequestModelArray","description":"The variants that should be merged to the target variant","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.MergeVariantRequestModelArray"},"examples":{"default":{"summary":"","description":"","value":[{"id":0}]}}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Products"]}},"/Experimental/taxonomy/{id}/parent":{"get":{"summary":"  Gets Taxonomy Parent\n","parameters":[{"name":"id","in":"path","required":true,"description":"","schema":{"type":"string","format":"int32"}}],"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.V5.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.V5.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.V5.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"]}},"/Experimental/product/{productId}/variants":{"patch":{"summary":"Updates multiple product variants\n","parameters":[{"name":"productId","in":"path","required":true,"description":"","schema":{"type":"string","format":"int64"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.VariantViewModelV5Array"},"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"}],"barcodes":[{"sticker_url":"string","value":"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":{"x-name":"products.UpdateProductVariantModelV5","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.UpdateProductVariantModelV5"},"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},"barcodes":[{"sticker_url":"string","value":"string"}],"bundle_definition":[{"quantity":0,"variant_id":0}],"channel_metadata":[{"asin":"string","channel_id":0,"channel_name":"string","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","currency":"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},"reviews_pending":[0],"sku":"string","status":1,"upc":"string","weight":0.1}}}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Products"]},"get":{"summary":"Gets multiple product variants\n","parameters":[{"name":"productId","in":"path","required":true,"description":"The product id\n","schema":{"type":"string","format":"int64"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.VariantViewModelV5Array"},"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"}],"barcodes":[{"sticker_url":"string","value":"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.Get.Api.V5.Product.ProductId.Variants.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.V5.Product.ProductId.Variants.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":"Adds new product variants to a product\n","parameters":[{"name":"productId","in":"path","required":true,"description":"","schema":{"type":"string","format":"int64"}}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.ProductViewModelV5"},"examples":{"default":{"summary":"","description":"","value":{"created_on":"2019-08-24T14:15:22+00:00","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"}],"barcodes":[{"sticker_url":"string","value":"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":{"x-name":"products.CreateProductVariantRequestModelV5Array","description":"The product variants to add to product","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.CreateProductVariantRequestModelV5Array"},"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},"barcodes":[{"sticker_url":"string","value":"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"]}},"/Experimental/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":{"type":"string"}},{"name":"Barcode","in":"query","description":"Barcode Associated with variant\n","schema":{"type":"string"}},{"name":"ChannelIds","in":"query","description":"Looks for Products variants by their channel IDs\n","schema":{"type":"string","items":{"type":"integer"}}},{"name":"HasDigitalVariants","in":"query","description":"Looks for Products with/without digital variants\n","schema":{"type":"string"}},{"name":"HasVariants","in":"query","description":"Looks for Products with/without variants\n","schema":{"type":"string"}},{"name":"InventoryId","in":"query","description":"Looks for variants by its associated inventory id\n","schema":{"type":"string","items":{"type":"integer"}}},{"name":"LastUpdatedTimestamp","in":"query","description":"Looks for Products that have been updated since the given date\n","schema":{"type":"string"}},{"name":"LegacyIds","in":"query","description":"Looks for Products with by Legacy Product Id(s)\n","schema":{"type":"string","items":{"type":"integer"}}},{"name":"Name","in":"query","description":"Looks for Products/Variants by name\n","schema":{"type":"string"}},{"name":"OnHand","in":"query","description":"Looks for Products with inventory\n","schema":{"type":"string"}},{"name":"PlatformIds","in":"query","description":"Looks for Products variants by their external Platform IDs\n","schema":{"type":"string","items":{"type":"string"}}},{"name":"ProductId","in":"query","description":"Looks for Products with an assigned Id\n","schema":{"type":"string","items":{"type":"integer"}}},{"name":"ProductType","in":"query","description":"Looks for Products by type\n","schema":{"type":"string"}},{"name":"ReviewsPending","in":"query","description":"Looks for Products by ReviewsPending\n","schema":{"type":"string","items":{"$ref":"#/components/schemas/Products.ReviewsPendingType"}}},{"name":"SalesChannel","in":"query","description":"Looks for Products variants assigned to a platform/sales channel \n","schema":{"type":"string","items":{"type":"string"}}},{"name":"SellerSKU","in":"query","description":"Looks for Products that match the provided Seller query\n","schema":{"type":"string"}},{"name":"SKU","in":"query","description":"Looks for Products that match the provided Sku query\n","schema":{"type":"string"}},{"name":"TaxonomyIds","in":"query","description":"Looks for Products variants by their taxonomy id or any descendants of the taxonomies sent separated by comma\n","schema":{"type":"string","items":{"type":"integer"}}},{"name":"VariantId","in":"query","description":"Looks for products that contain a variant with the given ID\n","schema":{"type":"string","items":{"type":"integer"}}},{"name":"VariantStatus","in":"query","description":"Looks for Products with variants that contain provided status\n","schema":{"type":"string"}},{"name":"PageSize","in":"query","description":"1-250\n","schema":{"type":"string"}},{"name":"SortBy","in":"query","description":"Id, Name, Category, TotalOnHandQty\n","schema":{"type":"string"}},{"name":"SortOrder","in":"query","description":"ASC,DESC\n","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.ProductViewModelV5PagedResponse"},"examples":{"default":{"summary":"","description":"","value":{"first":"string","items":[{"created_on":"2019-08-24T14:15:22+00:00","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"}],"barcodes":[{"sticker_url":"string","value":"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}}]}],"last":"string","next":"string","prev":"string"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.Get.Api.V5.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.V5.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.ProductViewModelV5"},"examples":{"default":{"summary":"","description":"","value":{"created_on":"2019-08-24T14:15:22+00:00","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"}],"barcodes":[{"sticker_url":"string","value":"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":{"x-name":"products.CreateProductRequestModelV5","description":"The product to add","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Products.CreateProductRequestModelV5"},"examples":{"default":{"summary":"","description":"","value":{"name":"string","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},"barcodes":[{"sticker_url":"string","value":"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"]}},"/Experimental/invoices":{"get":{"summary":"Get Invoices","description":"Gets a paginated list of invoices, optionally filtered by invoice types and date range","parameters":[{"name":"cursor","in":"query","description":"[Optional] A pagination token used to jump to first, last, next or previous pages. When supplied, it overrides all other filter parameters.\n","schema":{"type":"string"},"examples":{"default":{"summary":"","description":"","value":"f8cUk/xJkbeYp2fCr3yJJvL8oHqxL2hFiGz3qjqtkQ5Q0+BVMffFoIfoqzOkEsAw"}}},{"name":"fromDate","in":"query","description":"[Optional] Start date for filtering invoices by invoice date. Default is current - 1 month date.\n","schema":{"type":"string","format":"date-time"},"examples":{"default":{"summary":"","description":"","value":"2019-08-24"}}},{"name":"toDate","in":"query","description":"[Optional] End date for filtering invoices by invoice date. Default is current date.\n","schema":{"type":"string","format":"date-time"},"examples":{"default":{"summary":"","description":"","value":"2019-08-24T"}}},{"name":"invoiceTypes","in":"query","description":"[Optional] Filter invoices by invoice type. Valid values: Shipping,WarehouseStorage,Inbound Fee,Return,AdditionalFee,Credits","schema":{"type":"array","items":{"type":"string"}},"examples":{"default":{"summary":"","description":"","value":["Shipping","WarehouseStorage"]}}},{"name":"pageSize","in":"query","description":"Number of invoices to return per page (default: 100). Must be between 1 and 1000.\n","schema":{"type":"number","format":"int32"},"examples":{"default":{"summary":"","description":"","value":100}}},{"name":"sortOrder","in":"query","description":"Sort invoices by Invoice Date. Values - Ascending, Descending. Default: Descending.\n","schema":{"type":"string"},"examples":{"default":{"summary":"","description":"","value":"Descending"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Billing.InvoiceDtoCursorPagedResponse"},"examples":{"default":{"summary":"","description":"","value":{"first":"m8cUk/xJkbeYp2JJvL8oHqxL2hFuGz3qjqtkQ","items":[{"amount":0.01,"currencyCode":"USD","invoiceDate":"2019-08-24","invoiceId":12345,"invoiceType":"Shipping","runningBalance":123.01}],"last":"n8cUk/xJkbeYp2JJvL8oHqxL2hFiGz3qjqtkQ","next":"m8cUk/xJkbeYp2JhvL8oHqxL3hFiGz3qjqtkQ","prev":"m8cUk/xJkbeYp2JJvL8oHqxL2hFvGz3qjqtkQ"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Billing.ProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","property1":null,"property2":null,"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/Billing.ProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}}}},"500":{"description":"Server Error"}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Billing"]}},"/Experimental/invoices/{invoiceId}/transactions":{"get":{"summary":"Get transactions by invoiceid\n","description":"The unique identifier of the invoice whose transactions are to be retrieved","parameters":[{"name":"invoiceId","in":"path","required":true,"description":"The unique identifier of the invoice whose transactions are to be retrieved Ex:-12345.\n","schema":{"type":"string","format":"int32"}},{"name":"cursor","in":"query","description":"[Optional] A pagination token used to jump to first, last, next or previous pages. When supplied, it overrides all other filter parameters.\n","schema":{"type":"string"},"examples":{"default":{"summary":"","description":"","value":"f8cUk/xJkbeYp2fCr3yJJvL8oHqxL2hFiGz3qjqtkQ5Q0+BVMffFoIfoqzOkEsAw"}}},{"name":"pageSize","in":"query","description":"Number of transactions to return per page (default is 100, to be entered when API is called for first time). Must be between 1 and 1000.\n","schema":{"type":"number","format":"int32"},"examples":{"default":{"summary":"","description":"","value":100}}},{"name":"sortOrder","in":"query","description":"Sort order of the results. Valid values: Ascending or Descending (default: Descending).\n","schema":{"type":"string"},"examples":{"default":{"summary":"","description":"","value":"Descending"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Billing.TransactionDtoCursorPagedResponse"},"examples":{"default":{"summary":"","description":"","value":{"first":"f8cUk/xJkbeYp2L8oHqxL2hFiGz3qjre","items":[{"additionalDetails":{"Comment":"TestInvoice"},"amount":0.09,"chargeDate":"2025-01-01","chargeEndDate":"2025-01-12","chargeStartDate":"2025-01-06","currencyCode":"USD","fulfillmentCenter":"Altona VIC","invoiceDate":"2025-01-01","invoiceId":12345,"invoiceType":"Shipping","invoicedStatus":true,"referenceId":"12345","referenceType":"Shipment","taxes":[{"taxAmount":0.01,"taxRate":10,"taxType":"GST"}],"transactionFee":"Shipping","transactionId":"01AN4Z07BY79KA1307SR9X4MV3","transactionSubType":"WarehouseLeads","transactionType":"Charge"}],"last":"f8cUk/xJkbeYp2L8oHqxL2hFiGz3qjqt","next":"f8cUk/xjhyEYp2L8oHqxL2hFiGz3qjqt","prev":"f8cUk/xJkbeYp2L8oHqxL2hFiGz3qjcc"}}}}}},"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/Billing.ProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}}}},"500":{"description":"Server Error"}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Billing"]}},"/Experimental/transactions:query":{"post":{"summary":"Search transactions","description":"Search transactions with filters (date, invoice, fee type, etc.)","parameters":[{"name":"cursor","in":"query","description":"[Optional] A pagination token used to jump to first, last, next or previous pages. When supplied, it overrides all other filter parameters.\n","schema":{"type":"string"},"examples":{"default":{"summary":"","description":"","value":"f8cUk/xJkbeYp2fCr3yJJvL8oHqxL2hFiGz3qjqtkQ5Q0+BVMffFoIfoqzOkEsAw"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Billing.TransactionDtoCursorPagedResponse"},"examples":{"default":{"summary":"","description":"","value":{"first":"f8cUk/xJkbeYp2L8oHqxL2hFiGz3qjre","items":[{"additionalDetails":{"Comment":"TestInvoice"},"amount":0.09,"chargeDate":"2025-01-01","chargeEndDate":"2025-01-12","chargeStartDate":"2025-01-06","currencyCode":"USD","fulfillmentCenter":"Altona VIC","invoiceDate":"2025-01-01","invoiceId":12345,"invoiceType":"Shipping","invoicedStatus":true,"referenceId":"12345","referenceType":"Shipment","taxes":[{"taxAmount":0.01,"taxRate":10,"taxType":"GST"}],"transactionFee":"Shipping","transactionId":"01AN4Z07BY79KA1307SR9X4MV3","transactionSubType":"WarehouseLeads","transactionType":"Charge"}],"last":"f8cUk/xJkbeYp2L8oHqxL2hFiGz3qjqt","next":"f8cUk/xjhyEYp2L8oHqxL2hFiGz3qjqt","prev":"f8cUk/xJkbeYp2L8oHqxL2hFiGz3qjcc"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Billing.ProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}}}},"401":{"description":"Authorization missing or invalid"},"403":{"description":"The provided credentials are not authorized to access this resource"},"500":{"description":"Server Error"}},"requestBody":{"x-name":"billing.TransactionRequestFilter","description":"Used to filter transactions based on search criteria. Required if cursor is not provided. Ignored when cursor is present (i.e., for paginated requests).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Billing.TransactionRequestFilter"},"examples":{"default":{"summary":"","description":"","value":{"fromDate":"2019-08-24","invoiceIds":["123","456"],"invoicedStatus":true,"pageSize":0,"referenceIds":["11553288","43-12000928-Pallet00"],"referenceTypes":["FC"],"sortOrder":"Ascending","toDate":"2019-08-24","transactionFees":["Kitting Fee","Warehousing Fee"],"transactionTypes":["Charge"]}}}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Billing"]}},"/Experimental/transaction-fees":{"get":{"summary":"Get transaction fees\n","description":"This endpoint returns a list of transaction fees\n","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Billing.TransactionFeeModelV2"},"examples":{"default":{"summary":"","description":"","value":{"feeList":["Shipping"]}}}}}},"401":{"description":"Authorization missing or invalid"},"403":{"description":"The provided credentials are not authorized to access this resource"},"500":{"description":"Server Error"}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Billing"]}},"/Experimental/inventory/{inventoryId}":{"get":{"summary":"    Get Inventory\n","description":"  \tRetrieves detailed information about a specific inventory item by its ID, including product details, variant information, and associated metadata.\n","parameters":[{"name":"inventoryId","in":"path","required":true,"description":"","schema":{"type":"string","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.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/Inventory.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/Inventory.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/Inventory.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/Inventory.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"]}},"/Experimental/inventory-level":{"get":{"summary":"    Get All Inventory Levels\n","description":"  \tRetrieves current inventory levels across all locations. Returns available, on-hand, committed, and other quantity types. Supports filtering by inventory IDs and product attributes.\n","parameters":[{"name":"SearchBy","in":"query","description":"","schema":{"type":"string"},"examples":{"default":{"summary":"","description":"","value":"string"}}},{"name":"InventoryIds","in":"query","description":"","schema":{"type":"string","items":{"type":"integer","format":"int32"}},"examples":{"default":{"summary":"","description":"","value":[0]}}},{"name":"IsActive","in":"query","description":"","schema":{"type":"boolean"},"examples":{"default":{"summary":"","description":"","value":"True"}}},{"name":"IsDigital","in":"query","description":"","schema":{"type":"boolean"},"examples":{"default":{"summary":"","description":"","value":"True"}}},{"name":"PageSize","in":"query","description":"","schema":{"type":"string","format":"int32"}},{"name":"SortBy","in":"query","description":"","schema":{"type":"string"},"examples":{"default":{"summary":"","description":"","value":"string"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.InventoryQuantityV4ResponsePagedResponse"},"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_damaged_quantity":0,"total_exception_quantity":0,"total_fulfillable_quantity":0,"total_in_fulfillment_quantity":0,"total_internal_transfer_quantity":0,"total_on_hand_quantity":0,"total_quarantine_quantity":0,"total_sellable_quantity":0,"userId":0}],"last":"string","next":"string","prev":"string"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.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/Inventory.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/Inventory.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"]}},"/Experimental/inventory":{"get":{"summary":"    Get All Inventories\n","description":"  \tRetrieves a paginated list of all inventory items. Supports filtering by active status, tags, and various product attributes. Use query parameters to search and filter results.\n","parameters":[{"name":"SearchBy","in":"query","description":"","schema":{"type":"string"},"examples":{"default":{"summary":"","description":"","value":"string"}}},{"name":"FilterOperations","in":"query","description":"","schema":{"type":"string","items":{"$ref":"#/components/schemas/Inventory.FilterOperation"}},"examples":{"default":{"summary":"","description":"","value":[{"key":"string","rawValue":"string"}]}}},{"name":"InventoryIds","in":"query","description":"","schema":{"type":"string","items":{"type":"integer","format":"int32"}},"examples":{"default":{"summary":"","description":"","value":[0]}}},{"name":"IsActive","in":"query","description":"","schema":{"type":"boolean"},"examples":{"default":{"summary":"","description":"","value":"True"}}},{"name":"IsDigital","in":"query","description":"","schema":{"type":"boolean"},"examples":{"default":{"summary":"","description":"","value":"True"}}},{"name":"PageSize","in":"query","description":"","schema":{"type":"string","format":"int32"}},{"name":"SortBy","in":"query","description":"","schema":{"type":"string"},"examples":{"default":{"summary":"","description":"","value":"string"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.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/Inventory.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/Inventory.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/Inventory.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"]}},"/Experimental/kitting/action-types":{"get":{"summary":"Get Action Types\n","description":"Returns the available action types to configure steps in a kitting work order. Some action types may include sub-actions required for certain action types.\n","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Kitting.PublicWorkOrderActionTypesResponse"},"examples":{"default":{"summary":"","description":"","value":{"actions":[{"action_id":1,"active":true,"control_type":"scan","is_root":true,"name":"Scan Product Barcode","order":1,"sub_actions":[]},{"action_id":2,"active":true,"control_type":"checkbox","is_root":true,"name":"Package Items","order":2,"sub_actions":[{"action_id":3,"active":true,"control_type":"photo","is_root":false,"name":"Take Photo of Completed Kit","order":1,"sub_actions":[]}]}]}}}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Kitting.ApiError"},"examples":{"default":{"summary":"","description":"","value":{"details":null,"errors":[],"message":"An unexpected error occurred while retrieving action types.","stackTrace":null}}}}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Kitting"]}},"/Experimental/kitting:uploadAttachment":{"post":{"summary":"Upload Attachment\n","description":"Uploads an attachment for a kitting work order action step. The returned GUID can be used when creating the work order action attachment.\n\nRequest must be sent as **multipart/form-data** with the following fields:\n\n| Field | Type | Required | Description |\n|-------|------|----------|-------------|\n| file_name | string | Yes | The file name including extension (e.g. packaging-pic.jpg). Supported types: jpg, jpeg, png, pdf, csv, xlsx, xls, txt, gif, mp4. |\n| file | file | Yes | The binary file content to upload. |\n","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Kitting.AddAttachmentResponse"},"examples":{"default":{"summary":"","description":"","value":{"attachment_name":"string","id":"string"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"examples":{"default":{"summary":"","description":"","value":"FileName and file are required."}}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Kitting.ApiError"},"examples":{"default":{"summary":"","description":"","value":{"details":null,"errors":[],"message":"An unexpected error occurred while uploading the attachment.","stackTrace":null}}}}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Kitting"]}},"/Experimental/kitting:create":{"post":{"summary":"Create Work Order\n","description":"Creates a kitting work order. Currently only Kitting is supported as a work order type.\n","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Kitting.PublicCreateWorkOrderResponse"},"examples":{"default":{"summary":"","description":"","value":{"shipment_id":0}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"examples":{"default":{"summary":"","description":"","value":"Failed to create work order."}}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Kitting.ApiError"},"examples":{"default":{"summary":"","description":"","value":{"details":null,"errors":[],"message":"An unexpected error occurred while creating the work order.","stackTrace":null}}}}}}},"requestBody":{"x-name":"kitting.PublicCreateWorkOrderRequest","description":"The work order creation request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Kitting.PublicCreateWorkOrderRequest"},"examples":{"default":{"summary":"","description":"","value":{"actions":[{"attachments":[],"data":null,"instructions":"Scan the barcode on the product before kitting","order":1,"sub_actions":[],"work_order_action_type_id":1},{"attachments":[],"data":null,"instructions":"Package items according to kit specifications","order":2,"sub_actions":[{"attachments":[{"id":"photo-001","name":"completed-kit-photo"}],"data":null,"instructions":"Take a photo of the completed kit","order":1,"work_order_action_type_id":3}],"work_order_action_type_id":2}],"end_kitted_inventory_id":42,"fulfillment_center_id":1,"line_items":[{"inventory_id":101,"quantity":10}],"lot_date":"2024-01-15T09:00:00+00:00","lot_number":"LOT-2024-001","quantity":10,"workorder_type":"Kitting"}}}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Kitting"]}},"/Experimental/kitting:createFromExisting":{"post":{"summary":"Create Work Order from Existing\n","description":"Creates a kitting work order based on an existing shipment, including steps, line items, fulfillment center, and product details.\n","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Kitting.PublicWorkOrderShipmentIdResponse"},"examples":{"default":{"summary":"","description":"","value":{"shipment_id":0}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"examples":{"default":{"summary":"","description":"","value":"Failed to create work order from existing shipment"}}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Kitting.ApiError"},"examples":{"default":{"summary":"","description":"","value":{"details":null,"errors":[],"message":"An unexpected error occurred while creating work order from existing shipment.","stackTrace":null}}}}}}},"requestBody":{"x-name":"kitting.PublicKittingWorkOrderCopyRequest","description":"Request containing the details for creating the work order","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Kitting.PublicKittingWorkOrderCopyRequest"},"examples":{"default":{"summary":"","description":"","value":{"end_kitted_quantity":10,"fulfillment_center_id":1,"lot_date":"2024-01-15T09:00:00+00:00","lot_number":"LOT-2024-001","shipment_id":5001}}}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Kitting"]}},"/Experimental/inventory-level/{inventoryId}":{"get":{"summary":"    Get Inventory Levels\n","description":"    Retrieves the aggregated inventory levels for a specific inventory item across all locations, including available, on-hand, committed, and other quantity types.\n","parameters":[{"name":"inventoryId","in":"path","required":true,"description":"","schema":{"type":"string","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.InventoryQuantityV4Response"},"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_damaged_quantity":0,"total_exception_quantity":0,"total_fulfillable_quantity":0,"total_in_fulfillment_quantity":0,"total_internal_transfer_quantity":0,"total_on_hand_quantity":0,"total_quarantine_quantity":0,"total_sellable_quantity":0,"userId":0}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.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/Inventory.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/Inventory.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/Inventory.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"]}},"/Experimental/inventory-level/{inventoryId}/locations":{"get":{"summary":"    Get Inventory Levels Grouped By Fulfillment Center\n","description":"   \tRetrieves inventory levels for a specific inventory item broken down by fulfillment center location. Shows quantity breakdowns for each location where the inventory is stored.\n","parameters":[{"name":"inventoryId","in":"path","required":true,"description":"","schema":{"type":"string","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.InventoryQuantityFcV4Response"},"examples":{"default":{"summary":"","description":"","value":{"inventory_id":0,"locations":[{"awaiting_quantity":0,"committed_quantity":0,"damaged_quantity":0,"exception_quantity":0,"fulfillable_quantity":0,"in_fulfillment_quantity":0,"internal_transfer_quantity":0,"location_id":0,"name":"string","on_hand_quantity":0,"quarantine_quantity":0,"userId":0}],"name":"string","sku":"string","userId":0}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.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/Inventory.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/Inventory.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/Inventory.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"]}},"/Experimental/inventory-level/locations":{"get":{"summary":"    Get All Inventory Levels Grouped By Fulfillment Center\n","description":"    Retrieves inventory levels for all inventory items grouped by fulfillment center location. Supports filtering by location type, location ID, and various product attributes.\n","parameters":[{"name":"LocationType","in":"query","description":"","schema":{"type":"string"},"examples":{"default":{"summary":"","description":"","value":"string"}}},{"name":"LocationId","in":"query","description":"","schema":{"type":"string","format":"int32"}},{"name":"SearchBy","in":"query","description":"","schema":{"type":"string"},"examples":{"default":{"summary":"","description":"","value":"string"}}},{"name":"InventoryIds","in":"query","description":"","schema":{"type":"string","items":{"type":"integer","format":"int32"}},"examples":{"default":{"summary":"","description":"","value":[0]}}},{"name":"IsActive","in":"query","description":"","schema":{"type":"boolean"},"examples":{"default":{"summary":"","description":"","value":"True"}}},{"name":"IsDigital","in":"query","description":"","schema":{"type":"boolean"},"examples":{"default":{"summary":"","description":"","value":"True"}}},{"name":"PageSize","in":"query","description":"","schema":{"type":"string","format":"int32"}},{"name":"SortBy","in":"query","description":"","schema":{"type":"string"},"examples":{"default":{"summary":"","description":"","value":"string"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.InventoryQuantityFcV4ResponsePagedResponse"},"examples":{"default":{"summary":"","description":"","value":{"first":"string","items":[{"inventory_id":0,"locations":[{"awaiting_quantity":0,"committed_quantity":0,"damaged_quantity":0,"exception_quantity":0,"fulfillable_quantity":0,"in_fulfillment_quantity":0,"internal_transfer_quantity":0,"location_id":0,"name":"string","on_hand_quantity":0,"quarantine_quantity":0,"userId":0}],"name":"string","sku":"string","userId":0}],"last":"string","next":"string","prev":"string"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.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/Inventory.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/Inventory.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"]}},"/Experimental/inventory-level/lots":{"get":{"summary":"    Get All Inventory Levels Grouped By Lot\n","description":"    Retrieves inventory levels for all inventory items grouped by lot number. Enables tracking of inventory across multiple lots, including expiration dates and manufacturing batch information.\n","parameters":[{"name":"LocationId","in":"query","description":"","schema":{"type":"string","format":"int32"}},{"name":"SearchBy","in":"query","description":"","schema":{"type":"string"},"examples":{"default":{"summary":"","description":"","value":"string"}}},{"name":"InventoryIds","in":"query","description":"","schema":{"type":"string","items":{"type":"integer","format":"int32"}},"examples":{"default":{"summary":"","description":"","value":[0]}}},{"name":"IsActive","in":"query","description":"","schema":{"type":"boolean"},"examples":{"default":{"summary":"","description":"","value":"True"}}},{"name":"IsDigital","in":"query","description":"","schema":{"type":"boolean"},"examples":{"default":{"summary":"","description":"","value":"True"}}},{"name":"PageSize","in":"query","description":"","schema":{"type":"string","format":"int32"}},{"name":"SortBy","in":"query","description":"","schema":{"type":"string"},"examples":{"default":{"summary":"","description":"","value":"string"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.InventoryQuantityLotV4ResponsePagedResponse"},"examples":{"default":{"summary":"","description":"","value":{"first":"string","items":[{"inventory_id":0,"lots":[{"awaiting_quantity":0,"committed_quantity":0,"damaged_quantity":0,"exception_quantity":0,"fulfillable_quantity":0,"in_fulfillment_quantity":0,"internal_transfer_quantity":0,"locations":[{"awaiting_quantity":0,"committed_quantity":0,"damaged_quantity":0,"exception_quantity":0,"fulfillable_quantity":0,"in_fulfillment_quantity":0,"internal_transfer_quantity":0,"location_id":0,"name":"string","on_hand_quantity":0,"quarantine_quantity":0,"userId":0}],"lot_date":"2019-08-24T14:15:22+00:00","lot_number":"string","on_hand_quantity":0,"quarantine_quantity":0,"userId":0}],"name":"string","sku":"string","userId":0}],"last":"string","next":"string","prev":"string"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.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/Inventory.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/Inventory.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"]}},"/Experimental/inventory-level/{inventoryId}/lots":{"get":{"summary":"    Get Inventory Levels Grouped By Lot\n","description":"    Retrieves inventory levels for a specific inventory item broken down by lot number. Useful for tracking inventory by manufacturing lot, expiration date, or batch information.\n","parameters":[{"name":"inventoryId","in":"path","required":true,"description":"","schema":{"type":"string","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.InventoryQuantityLotV4Response"},"examples":{"default":{"summary":"","description":"","value":{"inventory_id":0,"lots":[{"awaiting_quantity":0,"committed_quantity":0,"damaged_quantity":0,"exception_quantity":0,"fulfillable_quantity":0,"in_fulfillment_quantity":0,"internal_transfer_quantity":0,"locations":[{"awaiting_quantity":0,"committed_quantity":0,"damaged_quantity":0,"exception_quantity":0,"fulfillable_quantity":0,"in_fulfillment_quantity":0,"internal_transfer_quantity":0,"location_id":0,"name":"string","on_hand_quantity":0,"quarantine_quantity":0,"userId":0}],"lot_date":"2019-08-24T14:15:22+00:00","lot_number":"string","on_hand_quantity":0,"quarantine_quantity":0,"userId":0}],"name":"string","sku":"string","userId":0}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.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/Inventory.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/Inventory.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/Inventory.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"]}},"/Experimental/lot-exclusion:delete":{"post":{"summary":"    Delete Lot Exclusion\n","description":"    Soft-deletes a lot exclusion for a specific inventory item. The exclusion can be restored later using the restore endpoint.\n","responses":{"200":{"description":"Lot exclusion successfully soft-deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.DeleteLotExclusionResponse"},"examples":{"default":{"summary":"","description":"","value":{"deleted_timestamp":"2019-08-24T14:15:22+00:00","inventory_id":123,"is_deleted":true,"lot_date":"2019-08-24T14:15:22+00:00","lot_number":"string"}}}}}},"400":{"description":"Invalid request, lot_number is required and either sku or inventory_id must be provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.ProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}}}},"401":{"description":"Authorization missing or invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.ProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}}}},"403":{"description":"The provided credentials are not authorized to access this resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.ProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}}}},"404":{"description":"Lot exclusion not found for the given inventory item and lot number","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.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"}},"requestBody":{"x-name":"inventory.Post.Api.V4.Lot.Exclusions.Delete.DeleteLotExclusionRequest","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.Post.Api.V4.Lot.Exclusions.Delete.DeleteLotExclusionRequest"},"examples":{"default":{"summary":"","description":"","value":{"inventory_id":123,"lot_date":"2019-08-24T14:15:22+00:00","lot_number":"string","sku":"string"}}}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Inventory"]}},"/Experimental/lot-exclusion":{"get":{"summary":"    Get Lot Exclusions\n","description":"    Retrieves lot exclusions for a specific inventory item. Filter by SKU or inventory ID to find which lots are excluded from fulfillment.\n","parameters":[{"name":"sku","in":"query","description":"SKU of the inventory item to retrieve lot exclusions for\n","schema":{"type":"string"}},{"name":"inventory_id","in":"query","description":"Unique identifier of the inventory item to retrieve lot exclusions for\n","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Successfully retrieved lot exclusions for the inventory item","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.LotExclusionsResponse"},"examples":{"default":{"summary":"","description":"","value":{"inventory_name":"string","inventory_sku":"string","lot_exclusions":[{"created_timestamp":"2019-08-24T14:15:22+00:00","deleted_timestamp":null,"id":1,"inventory_id":123,"is_deleted":false,"lot_date":"2019-08-24T14:15:22+00:00","lot_number":"string"}]}}}}}},"400":{"description":"Invalid request, either sku or inventory_id must be provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.ProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}}}},"401":{"description":"Authorization missing or invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.ProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}}}},"403":{"description":"The provided credentials are not authorized to access this resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.ProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}}}},"404":{"description":"Inventory item not found for the given sku or inventory_id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.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"]},"post":{"summary":"    Create Lot Exclusion\n","description":"    Creates a new lot exclusion for a specific inventory item. Excludes a lot number from being fulfilled for the given inventory.\n","responses":{"201":{"description":"Lot exclusion successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.CreateLotExclusionResponse"},"examples":{"default":{"summary":"","description":"","value":{"created_timestamp":"2019-08-24T14:15:22+00:00","deleted_timestamp":null,"id":1,"inventory_id":123,"is_deleted":false,"lot_date":"2019-08-24T14:15:22+00:00","lot_number":"string"}}}}}},"400":{"description":"Invalid request, lot_number is required and either sku or inventory_id must be provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.ProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}}}},"401":{"description":"Authorization missing or invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.ProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}}}},"403":{"description":"The provided credentials are not authorized to access this resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.ProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}}}},"404":{"description":"Inventory item not found for the given sku or inventory_id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.ProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}}}},"409":{"description":"A lot exclusion already exists for the given inventory item and lot number","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.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"}},"requestBody":{"x-name":"inventory.Post.Api.V4.Lot.Exclusions.CreateLotExclusionRequest","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.Post.Api.V4.Lot.Exclusions.CreateLotExclusionRequest"},"examples":{"default":{"summary":"","description":"","value":{"inventory_id":123,"lot_date":"2019-08-24T14:15:22+00:00","lot_number":"string","sku":"string"}}}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Inventory"]}},"/Experimental/lot-exclusion/restore":{"post":{"summary":"    Restore Lot Exclusion\n","description":"    Restores a previously deleted lot exclusion for a specific inventory item. Reverses a soft-delete operation.\n","responses":{"200":{"description":"Lot exclusion successfully restored","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.RestoreLotExclusionResponse"},"examples":{"default":{"summary":"","description":"","value":{"deleted_timestamp":null,"inventory_id":123,"is_deleted":false,"lot_date":"2019-08-24T14:15:22+00:00","lot_number":"string"}}}}}},"400":{"description":"Invalid request, lot_number is required and either sku or inventory_id must be provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.ProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}}}},"401":{"description":"Authorization missing or invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.ProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}}}},"403":{"description":"The provided credentials are not authorized to access this resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.ProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}}}},"404":{"description":"Lot exclusion not found for the given inventory item and lot number","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.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"}},"requestBody":{"x-name":"inventory.Post.Api.V4.Lot.Exclusions.Restore.RestoreLotExclusionRequest","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Inventory.Post.Api.V4.Lot.Exclusions.Restore.RestoreLotExclusionRequest"},"examples":{"default":{"summary":"","description":"","value":{"inventory_id":123,"lot_date":"2019-08-24T14:15:22+00:00","lot_number":"string","sku":"string"}}}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Inventory"]}},"/Experimental/receiving":{"post":{"summary":"Create Warehouse Receiving Order\n","responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receiving.V3.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","freight":{"bol_number":"string","carrier":"string","container_number":"string","freight_forwarder":"string","notes":"string","vessel_name":"string"},"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","status_history":[{"id":0,"status":"Processing","timestamp":"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/Receiving.ProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}}}},"422":{"description":"Unprocessable Content. Validation errors are returned keyed by field; business-rule errors that are not tied to a specific field are returned under an empty key. A receiving order referencing more than 10,000 unique inventory items (SKUs) across all of its boxes is rejected here with the WRO_UNIQUE_SKU_LIMIT_EXCEEDED reason code; the message includes the submitted and maximum counts so the request can be split.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receiving.Post.3.0.Receiving.Unprocessable.Entity.Object"},"examples":{"default":{"summary":"","description":"","value":{"property1":["string"],"property2":["string"]}},"unique_sku_limit_exceeded":{"summary":"","description":"","value":{"":["WRO_UNIQUE_SKU_LIMIT_EXCEEDED: WRO exceeds maximum of 10,000 unique inventory items per order. Submitted: 15234, Max: 10000."]}}}}}}},"requestBody":{"x-name":"receiving.V3.CreateReceivingOrderV3Model","description":"The receiving order to create","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Receiving.V3.CreateReceivingOrderV3Model"},"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,"sku":"string"}],"tracking_number":"860C8CDC8F0B4FC7AB69AC86C20539EC"}],"expected_arrival_date":"2019-08-24T14:15:22+00:00","final_destination_fulfillment_center_id":0,"freight":{"bol_number":"string","carrier":"string","container_number":"string","freight_forwarder":"string","notes":"string","vessel_name":"string"},"fulfillment_center":{"id":0},"package_type":"Package","purchase_order_number":"string"}}}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Receiving"]}},"/Experimental/return/{id}/label":{"post":{"summary":"Create Return Label\n","description":"Purchases a return shipping label for an existing return order. If a label has already been purchased, returns the existing label data (200 OK). Otherwise purchases a new label and returns it (201 Created).\n","parameters":[{"name":"id","in":"path","required":true,"description":"The unique identifier of the return order to purchase a label for","schema":{"type":"string","format":"int32"}},{"name":"api-version","in":"query","description":"The requested API version\n","schema":{"type":"string"},"examples":{"default":{"summary":"","description":"","value":1}}},{"name":"shipbob_channel_id","in":"header","required":true,"description":"Retrieve your channel ID from the [GET /channel](/api/channels/get-channels) endpoint. Use the channel ID that has write scopes.","schema":{"type":"string","format":"int32"}}],"responses":{"200":{"description":"Label already purchased — returns existing label data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Returns.CreateReturnLabelResponse"},"examples":{"default":{"summary":"","description":"","value":{"barcode":null,"carrier":"USPS","carrier_service":"Ground Advantage","label_request_id":999,"label_url":"https://s3.amazonaws.com/labels/label.pdf","label_zpl_url":"https://blob.core.windows.net/labels/label.zpl","purchase_date":"2026-04-13T12:00:00+00:00","qrcode_url":null,"rate":[{"amount":850,"currency_code":"USD"}],"return_id":12345,"shipment_rate_id":999,"tracking_number":"9400136105440512280610","tracking_url":"https://tools.usps.com/go/TrackConfirmAction?tLabels=9400136105440512280610"}}}}}},"201":{"description":"New label purchased successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Returns.CreateReturnLabelResponse"},"examples":{"default":{"summary":"","description":"","value":{"barcode":null,"carrier":"USPS","carrier_service":"Ground Advantage","label_request_id":999,"label_url":"https://s3.amazonaws.com/labels/label.pdf","label_zpl_url":"https://blob.core.windows.net/labels/label.zpl","purchase_date":"2026-04-13T12:00:00+00:00","qrcode_url":null,"rate":[{"amount":850,"currency_code":"USD"}],"return_id":12345,"shipment_rate_id":999,"tracking_number":"9400136105440512280610","tracking_url":"https://tools.usps.com/go/TrackConfirmAction?tLabels=9400136105440512280610"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Returns.ProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","property1":null,"property2":null,"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":"Return order not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Returns.ProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}}}},"422":{"description":"Validation failed (e.g. missing address, cancelled return, hazmat item)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Returns.ProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","status":422,"title":"string","type":"string"}}}}}}},"requestBody":{"x-name":"returns.CreateReturnLabelRequest","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Returns.CreateReturnLabelRequest"},"examples":{"default":{"summary":"","description":"","value":{"origin_address":{"city":"Chicago","company":"ACME Corp","country":"US","email":"jane@example.com","name":"Jane Doe","phone":"312-555-0100","state":"IL","street1":"123 Main St","street2":"Apt 4B","zip_code":"60601"},"shipment_id":98765,"shipping_service":"ReturnsStandard"}}}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Returns"]}},"/Experimental/return":{"post":{"summary":"Create Return Order\n","description":"Creates a new return order for a previously shipped order. Specify the original shipment, inventory items to return, and requested return actions. If purchase_label is true, also purchases a return shipping label using the original_shipment_id.\n","parameters":[{"name":"api-version","in":"query","description":"The requested API version\n","schema":{"type":"string"},"examples":{"default":{"summary":"","description":"","value":1}}},{"name":"shipbob_channel_id","in":"header","required":true,"description":"Retrieve your channel ID from the [GET /channel](/api/channels/get-channels) endpoint. Use the channel ID that has write scopes.","schema":{"type":"string","format":"int32"}}],"responses":{"201":{"description":"Return order created successfully. When purchase_label is true and the label purchase succeeds, both return and label are populated. When purchase_label is false, only return is populated. When purchase_label is true but the label purchase fails, return is populated, label is null, and label_error explains the failure.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Returns.CreateReturnWithLabelResponse"},"examples":{"default":{"summary":"","description":"","value":{"label":{"barcode":null,"carrier":"UPS","carrier_service":"Ground","label_request_id":999,"label_url":"https://easypost-files.s3.us-west-2.amazonaws.com/files/postage_label/label.png","label_zpl_url":"https://easypost-files.s3.us-west-2.amazonaws.com/files/postage_label/label.zpl","purchase_date":"2026-04-13T12:00:00+00:00","qrcode_url":null,"rate":[{"amount":1025,"currency_code":"USD"}],"return_id":12345,"shipment_rate_id":999,"tracking_number":"1Z999AA10123456784","tracking_url":"https://www.ups.com/track?tracknum=1Z999AA10123456784"},"label_error":null,"return":{"arrived_date":null,"awaiting_arrival_date":"2026-04-13T12:00:00+00:00","cancelled_date":null,"channel":{"id":1,"name":"ShipBob Default"},"completed_date":null,"customer_name":"Jane Doe","fulfillment_center":{"id":8,"name":"Cicero (IL)"},"id":12345,"insert_date":"2026-04-13T12:00:00+00:00","inventory":[{"action_requested":{"action":"Restock","action_type":"InventoryDefault","instructions":""},"action_taken":[],"barcodes":["BC-100"],"id":100,"lot_information":null,"name":"Test Product","quantity":1,"sku":"SKU-100"}],"invoice":null,"original_shipment_id":98765,"processing_date":null,"reference_id":"REF-12345","return_type":"Customer Generated","shipment_tracking_number":null,"status":"Awaiting Arrival","status_history":[{"status":"Awaiting Arrival","timestamp":"2026-04-13T12:00:00+00:00"}],"store_order_id":"SO-12345","tracking_number":null,"transactions":[]}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Returns.ProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","property1":null,"property2":null,"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":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Returns.ProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","status":422,"title":"string","type":"string"}}}}}}},"requestBody":{"x-name":"returns.CreateReturnRequest","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Returns.CreateReturnRequest"},"examples":{"default":{"summary":"","description":"","value":{"fulfillment_center":{"id":10,"name":"Cicero (CHI3)"},"inventory":[{"id":1279396,"lot_date":null,"lot_number":null,"quantity":2,"requested_action":"Restock"}],"original_shipment_id":98765,"purchase_label":true,"reference_id":"RMA-2026-00123","shipping_service":"ReturnsStandard","tracking_number":"1Z999AA10123456784"}}}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Returns"]}},"/Experimental/return:search":{"get":{"summary":"Search Return Orders\n","description":"Searches return orders by one or more comma-separated identifiers: return IDs (numeric), tracking numbers, or SKUs.\nAuto-detects the identifier type and returns exact matches only.\nWhen no SearchTerm is provided, returns all returns for the user (paginated).\nSupports additional filters (Status, ReturnTypes, etc.) applied on top of the search results.\n","parameters":[{"name":"SearchTerm","in":"query","description":"Comma-separated identifiers to search for. Can be return IDs, tracking numbers, or SKUs.\nWhen omitted, returns all returns for the user.\n","schema":{"type":"string"},"examples":{"default":{"summary":"","description":"","value":"string"}}},{"name":"Ids","in":"query","description":"Comma-separated list of return IDs to filter by (e.g., 511411,506640).\n","schema":{"type":"string"},"examples":{"default":{"summary":"","description":"","value":"string"}}},{"name":"Status","in":"query","description":"Comma-separated list of return statuses to filter by (e.g., 1,2,3).\n","schema":{"type":"string"},"examples":{"default":{"summary":"","description":"","value":"string"}}},{"name":"ReturnTypes","in":"query","description":"Comma-separated list of return types to filter by (e.g., 1,2).\n","schema":{"type":"string"},"examples":{"default":{"summary":"","description":"","value":"string"}}},{"name":"ReturnActions","in":"query","description":"Comma-separated list of return actions to filter by.\n","schema":{"type":"string"},"examples":{"default":{"summary":"","description":"","value":"string"}}},{"name":"FulfillmentCenterIds","in":"query","description":"Comma-separated list of fulfillment center IDs to filter by.\n","schema":{"type":"string"},"examples":{"default":{"summary":"","description":"","value":"string"}}},{"name":"TrackingNumbers","in":"query","description":"Comma-separated list of tracking numbers to filter by.\n","schema":{"type":"string"},"examples":{"default":{"summary":"","description":"","value":"string"}}},{"name":"ReferenceIds","in":"query","description":"Comma-separated list of return reference IDs (RMA numbers) to filter by.\n","schema":{"type":"string"},"examples":{"default":{"summary":"","description":"","value":"string"}}},{"name":"OriginalShipmentIds","in":"query","description":"Comma-separated list of original shipment IDs to filter by.\n","schema":{"type":"string"},"examples":{"default":{"summary":"","description":"","value":"string"}}},{"name":"InventoryIds","in":"query","description":"Comma-separated list of inventory IDs to filter by.\n","schema":{"type":"string"},"examples":{"default":{"summary":"","description":"","value":"string"}}},{"name":"StoreOrderIds","in":"query","description":"Comma-separated list of store order IDs to filter by.\n","schema":{"type":"string"},"examples":{"default":{"summary":"","description":"","value":"string"}}},{"name":"Sortby","in":"query","description":"Field to sort results by (e.g., Id, Status, InsertDate).\n","schema":{"type":"string"},"examples":{"default":{"summary":"","description":"","value":"string"}}},{"name":"StartDate","in":"query","description":"Filter returns created on or after this date (ISO 8601 format).\n","schema":{"type":"string","format":"date-time"},"examples":{"default":{"summary":"","description":"","value":"2019-08-24T14:15:22+00:00"}}},{"name":"EndDate","in":"query","description":"Filter returns created on or before this date (ISO 8601 format).\n","schema":{"type":"string","format":"date-time"},"examples":{"default":{"summary":"","description":"","value":"2019-08-24T14:15:22+00:00"}}},{"name":"CompletedStartDate","in":"query","description":"Filter returns completed on or after this date (ISO 8601 format).\n","schema":{"type":"string","format":"date-time"},"examples":{"default":{"summary":"","description":"","value":"2019-08-24T14:15:22+00:00"}}},{"name":"CompletedEndDate","in":"query","description":"Filter returns completed on or before this date (ISO 8601 format).\n","schema":{"type":"string","format":"date-time"},"examples":{"default":{"summary":"","description":"","value":"2019-08-24T14:15:22+00:00"}}},{"name":"Cursor","in":"query","description":"Page number to retrieve. Used for pagination through result sets.\n","schema":{"type":"number","format":"int32","maximum":2147483647.0,"minimum":1.0},"examples":{"default":{"summary":"","description":"","value":1}}},{"name":"Limit","in":"query","description":"Maximum number of records to return per page.\n","schema":{"type":"number","format":"int32"},"examples":{"default":{"summary":"","description":"","value":25}}},{"name":"SortOrder","in":"query","description":"Sort order for results. Desc = newest to oldest, Asc = oldest to newest, Desc is default\n","schema":{"type":"string"},"examples":{"default":{"summary":"","description":"","value":"Desc"}}},{"name":"api-version","in":"query","description":"The requested API version\n","schema":{"type":"string"},"examples":{"default":{"summary":"","description":"","value":1}}},{"name":"shipbob_channel_id","in":"header","description":"Retrieve your channel ID from the [GET /channel](/api/channels/get-channels) endpoint.","schema":{"type":"string","format":"int32"}}],"responses":{"200":{"description":"OK","headers":{"Page-Number":{"description":"Current page number\n","schema":{"type":"object","format":"","additionalProperties":false}},"Total-Pages":{"description":"Total pages\n","schema":{"type":"object","format":"","additionalProperties":false}},"Total-Count":{"description":"Total records\n","schema":{"type":"object","format":"","additionalProperties":false}},"Page-Size":{"description":"Page size\n","schema":{"type":"object","format":"","additionalProperties":false}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Returns.PublicReturnDtoPagedUrlResultDto"},"examples":{"default":{"summary":"","description":"","value":{"first":"https://api.shipbob.com/experimental/return:search?Cursor=1&Limit=25&SortOrder=Desc","items":[{"arrived_date":null,"awaiting_arrival_date":"2026-04-17T06:53:12.51+00:00","cancelled_date":null,"channel":{"id":1,"name":"ShipBob Merchant Portal"},"completed_date":null,"customer_name":"John Smith","fulfillment_center":{"id":10,"name":"Moreno Valley (CA)"},"id":511411,"insert_date":"2026-04-17T06:53:12.398001+00:00","inventory":[{"action_requested":{"action":"Restock","action_type":"InventoryDefault","instructions":""},"action_taken":[],"barcodes":[],"id":3364038,"lot_information":null,"name":"TShirt-MV","quantity":2,"sku":"tshirt-mv"}],"invoice":{"amount":5.99,"currency_code":"USD"},"original_shipment_id":12345678,"processing_date":null,"reference_id":"d66b2018-8917-493a-926d-78fd5550ba5c","return_type":"Customer Generated","shipment_tracking_number":"1Z999AA10123456784","status":"Awaiting Arrival","status_history":[{"status":"Awaiting Arrival","timestamp":"2026-04-17T06:53:12.51+00:00"}],"store_order_id":"SO-98765","tracking_number":"1Z999AA10123456784","transactions":[]}],"last":"https://api.shipbob.com/experimental/return:search?Cursor=1&Limit=25&SortOrder=Desc","next":"https://api.shipbob.com/experimental/return:search?Cursor=2&Limit=25&SortOrder=Desc","prev":null}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Returns.ProblemDetails"},"examples":{"default":{"summary":"","description":"","value":{"detail":"string","instance":"string","property1":null,"property2":null,"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":"Resource Not Found"}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Returns"]}}},"components":{"schemas":{"Account.Get.Api.V1.CompanyMapping.Subaccounts.ParentUserId.ParentUserId.Integer":{"type":"integer","description":"The unique identifier of the sub-account","format":"int32"},"Account.SubaccountGetChildResponse":{"type":"object","additionalProperties":false,"properties":{"additional_fields":{"type":"object","description":"Additional key-value metadata associated with the sub-account.","additionalProperties":{"type":"string","nullable":true},"nullable":true},"created_date":{"type":"string","description":"The UTC date and time when the sub-account was created.","format":"date-time"},"email":{"type":"string","description":"The email address of the sub-account owner.","nullable":true},"first_name":{"type":"string","description":"The first name of the sub-account owner.","nullable":true},"id":{"type":"integer","description":"The unique identifier of the sub-account.","format":"int32"},"last_name":{"type":"string","description":"The last name of the sub-account owner.","nullable":true},"updated_date":{"type":"string","description":"The UTC date and time when the sub-account was last updated.","format":"date-time"}}},"Account.SubaccountGetChildResponseArray":{"type":"array","items":{"$ref":"#/components/schemas/Account.SubaccountGetChildResponse"}},"Attachment.Post.Api.Attachment.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Attachment.Post.Api.Attachment.Unprocessable.Entity.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Attachment.Post.Api.BlobKey.String":{"type":"string"},"Attachment.Post.Api.DomainType.Integer":{"type":"integer","format":"int32"},"Attachment.Post.Api.FileName.String":{"type":"string"},"Attachment.Post.Api.FileType.Integer":{"type":"integer","format":"int32"},"Attachments.CreateViewModel":{"type":"object","example":{"AttachmentName":"TestText.csv","AttachmentUri":"http://cdn.shipbob.com/api/attachment/902-29121291202121821821-21sdhshd"},"additionalProperties":false,"properties":{"AttachmentName":{"type":"string","description":"Name of the attachment"},"AttachmentUri":{"type":"string","description":"Uri for the attachment"}}},"Billing.ClaimBillingDetailsResponse":{"type":"object","description":"Response model containing claim billing details for a shipment.","additionalProperties":false,"properties":{"charge":{"description":"Claim processing fee charge details. Null when the merchant has not opted into proactive claims, or when status is 'pending', 'not_found', or 'not_applicable'.","$ref":"#/components/schemas/Billing.ClaimChargeDetail","nullable":true},"credit":{"description":"Lost-order credit details. Null when status is 'not_found'.","$ref":"#/components/schemas/Billing.ClaimCreditDetail","nullable":true},"currency_code":{"type":"string","example":"USD","nullable":true},"currency_conversion":{"description":"Currency conversion details if a currency conversion is applied to the credit and charge amounts. Null when no currency conversion is applied.","$ref":"#/components/schemas/Billing.ClaimCurrencyConversion","nullable":true},"shipment_id":{"type":"integer","format":"int64"},"status":{"type":"string","description":"'success' = credit and charge both processed; 'pending' = credit processed but charge not yet; 'not_found' = no credit or charge found for this shipment ID; 'not_applicable' = credit is created but proactive claim charge is not applicable for this shipment (e.g. merchant not opted in, or claim created outside of proactive claim eligibility window).","enum":["success","pending","not_found","not_applicable"]},"user_id":{"type":"integer","format":"int32","nullable":true}}},"Billing.ClaimBillingDetailsResponseArray":{"type":"array","items":{"$ref":"#/components/schemas/Billing.ClaimBillingDetailsResponse"}},"Billing.ClaimChargeDetail":{"type":"object","description":"Details of the claim processing fee charge transaction.","additionalProperties":false,"properties":{"amount":{"type":"number","format":"double","example":1.23,"nullable":true},"transaction_date":{"type":"string","description":"UTC timestamp of the charge transaction.","format":"date-time","nullable":true},"transaction_fee":{"type":"string","description":"The fee type applied to the claim.","example":"Proactive Processing Fee","nullable":true},"transaction_id":{"type":"string","description":"Unique transaction identifier. Null when amount is 0 (no charge transaction is created).","example":"01KMR3M2MJFQ32BASRB453477F","nullable":true}}},"Billing.ClaimCreditDetail":{"type":"object","description":"Details of the lost-order credit transaction.","additionalProperties":false,"properties":{"amount":{"type":"number","format":"double","example":12.34,"nullable":true},"credit_reason":{"type":"string","description":"The reason for the credit","example":"Claim for Lost Order","nullable":true},"transaction_date":{"type":"string","description":"UTC timestamp of the credit transaction.","format":"date-time","nullable":true},"transaction_id":{"type":"string","description":"Unique transaction identifier for the credit transaction. Null when amount is 0 (no credit transaction is created).","example":"01KMR3M2MJFQ32BASRB453477F","nullable":true}}},"Billing.ClaimCurrencyConversion":{"type":"object","description":"Details of the currency conversion transaction.","additionalProperties":false,"properties":{"conversion_date":{"type":"string","description":"UTC timestamp of the conversion time.","format":"date-time","nullable":true},"conversion_rate":{"type":"number","description":"The conversion rate applied to the original amount.","format":"double","example":0.73,"nullable":true},"original_credit_amount":{"type":"number","format":"double","example":12.34,"nullable":true},"original_currency":{"type":"string","description":"The original currency of the amount before conversion","example":"CAD","nullable":true}}},"Billing.DateOnly":{"type":"object","additionalProperties":false,"properties":{"day":{"type":"integer","format":"int32"},"dayNumber":{"type":"integer","readOnly":true,"format":"int32"},"dayOfWeek":{"$ref":"#/components/schemas/Billing.DayOfWeek"},"dayOfYear":{"type":"integer","readOnly":true,"format":"int32"},"month":{"type":"integer","format":"int32"},"year":{"type":"integer","format":"int32"}}},"Billing.DayOfWeek":{"type":"integer","format":"int32","enum":[0,1,2,3,4,5,6]},"Billing.Get.Api.Shipment.Claims.Billed.Shipment.Ids.String":{"type":"string","description":"Comma-separated list of shipment IDs (maximum 100)."},"Billing.Get.Api.V2.Invoices.InvoiceId.Transactions.Cursor.String":{"type":"string"},"Billing.Get.Api.V2.Invoices.InvoiceId.Transactions.InvoiceId.Integer":{"type":"integer","format":"int32"},"Billing.Get.Api.V2.Invoices.InvoiceId.Transactions.PageSize.Integer":{"type":"integer","format":"int32","default":100},"Billing.Get.Api.V2.TransactionV2.Invoices.Cursor.String":{"type":"string"},"Billing.Get.Api.V2.TransactionV2.Invoices.FromDate.String":{"type":"string","format":"date-time"},"Billing.Get.Api.V2.TransactionV2.Invoices.InvoiceTypes.StringArray":{"type":"array","items":{"type":"string"}},"Billing.Get.Api.V2.TransactionV2.Invoices.PageSize.Integer":{"type":"integer","format":"int32","default":100},"Billing.Get.Api.V2.TransactionV2.Invoices.ToDate.String":{"type":"string","format":"date-time"},"Billing.InvoiceDto":{"type":"object","description":"Data transfer object representing an invoice.","additionalProperties":false,"properties":{"amount":{"type":"number","description":"The total invoice amount.","format":"double","example":0.01},"currencyCode":{"type":"string","description":"The ISO currency code used in the invoice (e.g., USD, EUR).","example":"USD","nullable":true},"invoiceDate":{"type":"string","description":"The invoice date in yyyy-mm-dd format.","example":"2025-01-01","nullable":true},"invoiceId":{"type":"integer","description":"Unique identifier for the invoice.","format":"int32","example":12345},"invoiceType":{"type":"string","description":"The type or category of the invoice. Available options:\r\n- Shipping  \r\n- Inbound Fee  \r\n- WarehouseStorage  \r\n- AdditionalFee  \r\n- Return   \r\n- Credits  \r\n- BalanceAdjustment  \r\n- Payment","nullable":true},"runningBalance":{"type":"number","description":"The running balance of the account after this invoice is applied.","format":"double","example":123.01}}},"Billing.InvoiceDtoCursorPagedResponse":{"type":"object","additionalProperties":false,"properties":{"first":{"type":"string","description":"Go to the first page","nullable":true},"items":{"type":"array","items":{"$ref":"#/components/schemas/Billing.InvoiceDto"},"nullable":true},"last":{"type":"string","description":"Go to the Last page","nullable":true},"next":{"type":"string","description":"Go to the Next page","nullable":true},"prev":{"type":"string","description":"Go to the Previous page","nullable":true}}},"Billing.InvoiceTaxDto":{"type":"object","additionalProperties":false,"properties":{"taxAmount":{"type":"number","description":"Tax amount charged for the tax type.","format":"double","example":0.01},"taxRate":{"type":"number","description":"Rate of Tax charged for the tax type","format":"double","example":10},"taxType":{"type":"string","description":"Type of tax charged for eg. GST","example":"GST","nullable":true}}},"Billing.Post.Api.V2.Transactions.Query.Cursor.String":{"type":"string"},"Billing.ProblemDetails":{"type":"object","additionalProperties":{"additionalProperties":false},"properties":{"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"title":{"type":"string","nullable":true},"type":{"type":"string","nullable":true}}},"Billing.SortOrder":{"type":"string","enum":["Ascending","Descending"]},"Billing.TransactionDto":{"type":"object","description":"Represents a transaction data object.","additionalProperties":false,"properties":{"additionalDetails":{"type":"object","description":"Any additional details related to the transaction in a key-value pair format.","additionalProperties":{"additionalProperties":false,"nullable":true},"nullable":true},"amount":{"type":"number","description":"Charge Amount for the transaction","format":"double","example":0.09,"nullable":true},"chargeDate":{"type":"string","description":"The Charge date of transaction","example":"2025-01-01","nullable":true},"chargeEndDate":{"type":"string","description":"The end of the billing period for which the charge applies. Null when not applicable.","example":"2025-01-12","nullable":true},"chargeStartDate":{"type":"string","description":"The start of the billing period for which the charge applies. Null when not applicable.","example":"2025-01-06","nullable":true},"currencyCode":{"type":"string","description":"The ISO currency code (e.g., USD, EUR) for the transaction","example":"USD","nullable":true},"fulfillmentCenter":{"type":"string","description":"The name or code of the fulfillment center involved in the transaction.","example":"Altona VIC","nullable":true},"invoiceDate":{"type":"string","description":"The date the invoice was generated","example":"2025-01-01","nullable":true},"invoiceId":{"type":"integer","description":"The unique identifier of the related invoice.","format":"int32","example":12345,"nullable":true},"invoiceType":{"type":"string","description":"The type or category of the invoice. Available options:\r\n- Shipping  \r\n- Inbound Fee  \r\n- WarehouseStorage  \r\n- AdditionalFee  \r\n- Return   \r\n- Credits  \r\n- BalanceAdjustment  \r\n- Payment","example":"Shipping","nullable":true},"invoicedStatus":{"type":"boolean","description":"Indicates whether the transaction has been invoiced.","example":true,"nullable":true},"referenceId":{"type":"string","description":"A unique reference identifier associated with the transaction","example":"12345","nullable":true},"referenceType":{"type":"string","description":"The type of reference associated with the ReferenceId. Available options:\r\n- Shipment  \r\n- Return  \r\n- WRO  \r\n- URO  \r\n- Ticket Number  \r\n- FC  \r\n- LPN Reference  \r\n- Transfer Plan","example":"Shipment","nullable":true},"taxes":{"type":"array","description":"A list of tax details applied to the transaction if exists.","items":{"$ref":"#/components/schemas/Billing.InvoiceTaxDto"},"nullable":true},"transactionFee":{"type":"string","description":"The fee type associated with the transaction for eg. Shipping fees\r\nTo get all the available transaction fees use the endpoint -  '/transaction-fees'","example":"Shipping","nullable":true},"transactionId":{"type":"string","description":"The unique identifier for transaction","example":"01AN4Z07BY79KA1307SR9X4MV3","nullable":true},"transactionSubType":{"type":"string","description":"The subtype label for the charge (e.g., labor role or packaging type). Null when the transaction has no subtype.","example":"WarehouseLeads","nullable":true},"transactionType":{"type":"string","description":"The classification or nature of the transaction \r\nTransaction Types - Charge, Refund, Credit, Payment, BalanceAdjustment","example":"Charge","nullable":true}}},"Billing.TransactionDtoCursorPagedResponse":{"type":"object","additionalProperties":false,"properties":{"first":{"type":"string","description":"Go to the first page","nullable":true},"items":{"type":"array","items":{"$ref":"#/components/schemas/Billing.TransactionDto"},"nullable":true},"last":{"type":"string","description":"Go to the Last page","nullable":true},"next":{"type":"string","description":"Go to the Next page","nullable":true},"prev":{"type":"string","description":"Go to the Previous page","nullable":true}}},"Billing.TransactionFeeModelV2":{"type":"object","additionalProperties":false,"properties":{"feeList":{"type":"array","items":{"type":"string"},"nullable":true}}},"Billing.TransactionRequestFilter":{"type":"object","example":{"fromDate":"2019-08-24","invoiceIds":["123","456"],"invoicedStatus":true,"pageSize":0,"referenceIds":["11553288","43-12000928-Pallet00"],"referenceTypes":["FC"],"sortOrder":"Ascending","toDate":"2019-08-24","transactionFees":["Kitting Fee","Warehousing Fee"],"transactionTypes":["Charge"]},"additionalProperties":false,"properties":{"fromDate":{"type":"string","description":"Start date for filtering transactions by transaction charge date. Default is current – 7 days","format":"date-time","nullable":true},"invoiceIds":{"type":"array","description":"List of invoice IDs to filter transactions","items":{"type":"string"},"nullable":true},"invoicedStatus":{"type":"boolean","description":"Filter Transactions by invoicing status:\r\n- True(Billed Transactions)\r\n- False(Unbilled Transactions)\r\n- null (Billed + Unbilled Transactions)","nullable":true},"pageSize":{"type":"integer","description":"Number of transactions to return per page (default is 100, to be entered when API is called for first time). Must be between 1 and 1000.","format":"int32"},"referenceIds":{"type":"array","description":"List of reference IDs (like Shipment ID, WRO id) to filter transactions (can be numeric or string identifiers).","items":{"type":"string"},"nullable":true},"referenceTypes":{"type":"array","description":"The type of reference associated with the ReferenceId. Available options:\r\n- Shipment  \r\n- Return  \r\n- WRO  \r\n- URO","items":{"type":"string"},"nullable":true},"sortOrder":{"$ref":"#/components/schemas/Billing.SortOrder"},"toDate":{"type":"string","description":"End date for filtering transactions by transaction charge date. Default is current date.","format":"date-time","nullable":true},"transactionFees":{"type":"array","description":"To get all the available transaction fees use this endpoint:- '/transaction-fees'","items":{"type":"string"},"nullable":true},"transactionTypes":{"type":"array","description":"The classification or nature of the transaction \r\nTransaction Types - Charge, Refund, Credit, Payment, BalanceAdjustment","items":{"type":"string"},"nullable":true}}},"Channels.ChannelViewModel":{"type":"object","additionalProperties":false,"properties":{"application_name":{"type":"string","description":"Name of the application that owns the channel","example":"Api","nullable":true},"id":{"type":"integer","description":"Unique id of the channel","format":"int32"},"name":{"type":"string","description":"Name of the channel","nullable":true},"scopes":{"type":"array","description":"Array of permissions granted for the channel","example":["channels_read","orders_read","orders_write"],"items":{"type":"string"},"nullable":true}}},"Channels.CreateChannelRequestModel":{"type":"object","description":"Model for create channel request","example":{"name":"string"},"additionalProperties":false,"required":["name"],"properties":{"name":{"type":"string","description":"Name of the channel","minLength":1}}},"Channels.Post.Api.V2.Channel.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Channels.Post.Api.V2.Channel.InheritScopes.Boolean":{"type":"boolean","default":false},"Channels.Post.Api.V2.Channel.Search.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Channels.v2.ChannelBasicViewModel":{"type":"object","description":"Channel basic information","additionalProperties":false,"properties":{"id":{"type":"integer","description":"","format":"int32"},"name":{"type":"string","description":"","nullable":true}}},"Channels.v2.ChannelSearchViewModel":{"type":"object","description":"GChannel search response","additionalProperties":false,"properties":{"items":{"type":"array","description":"List of channels","items":{"$ref":"#/components/schemas/Channels.v2.ChannelBasicViewModel"},"nullable":true},"next":{"type":"string","description":"Next page cursor","nullable":true},"prev":{"type":"string","description":"Previous page cursor","nullable":true},"total_records":{"type":"integer","description":"Total records on current page","format":"int32"}}},"Channels.v2.ChannelsV2SearchRequest":{"type":"object","description":"Channel search request body","example":{"cursor":"string","records_per_page":0,"search_filters":{"channel_ids":[0],"channel_names":["string"]}},"additionalProperties":false,"properties":{"cursor":{"type":"string","description":"Next/Previous Cursor","nullable":true},"records_per_page":{"type":"integer","description":"Records Per Page","format":"int32"},"search_filters":{"$ref":"#/components/schemas/Channels.v2.SearchFilters"}}},"Channels.v2.SearchFilters":{"type":"object","description":"Search filters","additionalProperties":false,"properties":{"channel_ids":{"type":"array","description":"Channel Ids to search for","items":{"type":"integer","format":"int32"},"nullable":true},"channel_names":{"type":"array","description":"Channel Names to search for","items":{"type":"string"},"nullable":true}}},"FacilityWorkflowIntegrations.CreateInventoryLotExclusionBody":{"type":"object","description":"Request body for creating an inventory lot exclusion.","additionalProperties":false,"required":["inventoryId"],"properties":{"inventoryId":{"type":"integer","description":"The unique identifier for the inventory item.","format":"int32"},"lotDate":{"type":"string","description":"The lot date to exclude.","format":"date-time","nullable":true},"lotNumber":{"type":"string","description":"The lot number to exclude.","nullable":true}}},"FacilityWorkflowIntegrations.CreateLotExclusionResponse":{"type":"object","description":"Response for creating an inventory lot exclusion.","additionalProperties":false,"properties":{"created":{"type":"boolean","description":"Indicates whether the lot exclusion was created successfully."},"failureReason":{"type":"integer","description":"Reason for failure if not created.","format":"int32"},"item":{"type":"object","additionalProperties":false,"properties":{"createdTimestamp":{"type":"string","format":"date-time"},"deletedTimestamp":{"type":"string","format":"date-time","nullable":true},"id":{"type":"integer","format":"int32"},"inventoryId":{"type":"integer","format":"int32"},"isDeleted":{"type":"boolean"},"lotDate":{"type":"string","format":"date-time","nullable":true},"lotNumber":{"type":"string","nullable":true},"userId":{"type":"integer","format":"int32"}},"nullable":true},"message":{"type":"string","description":"Message describing the result.","nullable":true}}},"FacilityWorkflowIntegrations.LotExclusionMutationBody":{"type":"object","description":"Request body for mutating (deleting or restoring) an inventory lot exclusion.","additionalProperties":false,"required":["id"],"properties":{"id":{"type":"integer","description":"The unique identifier for the inventory lot exclusion.","format":"int32"}}},"FacilityWorkflowIntegrations.MutateLotExclusionResponse":{"type":"object","description":"Response for mutating (deleting or restoring) an inventory lot exclusion.","additionalProperties":false,"properties":{"deletedTimestamp":{"type":"string","description":"Timestamp when the lot exclusion was deleted.","format":"date-time","nullable":true},"failureReason":{"type":"integer","description":"Reason for failure if not successful.","format":"int32"},"isDeleted":{"type":"boolean","description":"Current deletion status of the lot exclusion."},"message":{"type":"string","description":"Message describing the result.","nullable":true},"success":{"type":"boolean","description":"Indicates whether the mutation was successful."}}},"FacilityWorkflowIntegrations.ShopifyPickData":{"type":"object","description":"The data provided by a Shopify flow.","example":{"fulfillmentCenterId":0,"inventorySku":"string","quantityToPick":0,"transactionId":"string"},"additionalProperties":false,"required":["fulfillmentCenterId","inventorySku","quantityToPick","transactionId"],"properties":{"fulfillmentCenterId":{"type":"integer","description":"A representation of a specific facility.","format":"int32"},"inventorySku":{"type":"string","description":"An identifier for a particular piece of inventory.","nullable":true},"quantityToPick":{"type":"integer","description":"The quantity to be picked.","format":"int32"},"transactionId":{"type":"string","description":"The unique identifier for a transaction.","nullable":true}}},"FacilityWorkflowIntegrations.ShopifyResponseError":{"type":"object","additionalProperties":false,"properties":{"errorMessage":{"type":"string","nullable":true}}},"FulfillmentCenterInventoryService.Get.Inventory.InventoryId.History.Cursor.Integer":{"type":"integer","format":"int32"},"FulfillmentCenterInventoryService.Get.Inventory.InventoryId.History.EndDate.String":{"type":"string","format":"date-time"},"FulfillmentCenterInventoryService.Get.Inventory.InventoryId.History.EventCategory.String":{"type":"string"},"FulfillmentCenterInventoryService.Get.Inventory.InventoryId.History.FacilityId.Integer":{"type":"integer","format":"int32"},"FulfillmentCenterInventoryService.Get.Inventory.InventoryId.History.InventoryId.Integer":{"type":"integer","format":"int32"},"FulfillmentCenterInventoryService.Get.Inventory.InventoryId.History.StartDate.String":{"type":"string","format":"date-time"},"FulfillmentCenterInventoryService.InventoryHistory":{"type":"object","additionalProperties":false,"properties":{"additional_reference":{"type":"array","items":{"$ref":"#/components/schemas/FulfillmentCenterInventoryService.InventoryHistoryAdditionalReference"},"nullable":true},"decrement":{"$ref":"#/components/schemas/FulfillmentCenterInventoryService.InventoryHistoryDetails"},"event_category":{"type":"string","nullable":true},"event_datetime":{"type":"string","format":"date-time"},"increment":{"$ref":"#/components/schemas/FulfillmentCenterInventoryService.InventoryHistoryDetails"},"inventory_audit_event_id":{"type":"integer","format":"int32"},"inventory_id":{"type":"integer","format":"int32"},"merchant_user_id":{"type":"integer","format":"int32","nullable":true},"shipbob_order_id":{"type":"integer","format":"int32","nullable":true}}},"FulfillmentCenterInventoryService.InventoryHistoryAdditionalReference":{"type":"object","additionalProperties":false,"properties":{"key":{"type":"string","nullable":true},"value":{"type":"string","nullable":true}}},"FulfillmentCenterInventoryService.InventoryHistoryDetails":{"type":"object","additionalProperties":false,"properties":{"committed_quantity_change":{"type":"integer","format":"int32"},"expiration_date":{"type":"string","format":"date-time","nullable":true},"facility_id":{"type":"integer","format":"int32"},"inventory_status":{"type":"string","nullable":true},"location_id":{"type":"integer","format":"int32"},"lot_number":{"type":"string","nullable":true},"operational_stage":{"$ref":"#/components/schemas/FulfillmentCenterInventoryService.YukiOperationalStageEnumTypeResponse"},"pack_description_id":{"$ref":"#/components/schemas/FulfillmentCenterInventoryService.Ulid"},"quantity_change":{"type":"integer","format":"int32"},"sku":{"type":"string","nullable":true},"yuki_id":{"$ref":"#/components/schemas/FulfillmentCenterInventoryService.Ulid"}}},"FulfillmentCenterInventoryService.InventoryHistoryResponse":{"type":"object","additionalProperties":false,"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FulfillmentCenterInventoryService.InventoryHistory"},"nullable":true},"first":{"type":"string","nullable":true},"last":{"type":"string","nullable":true},"next":{"type":"string","nullable":true},"prev":{"type":"string","nullable":true}}},"FulfillmentCenterInventoryService.MerchantHistoryRequest":{"type":"object","example":{"cursor":0,"end_date":"2019-08-24T14:15:22Z","event_category":"string","facility_id":0,"inventory_ids":[0],"merchant_user_id":0,"start_date":"2019-08-24T14:15:22Z"},"additionalProperties":false,"properties":{"cursor":{"type":"integer","format":"int32","nullable":true},"end_date":{"type":"string","format":"date-time","nullable":true},"event_category":{"type":"string","nullable":true},"facility_id":{"type":"integer","format":"int32"},"inventory_ids":{"type":"array","items":{"type":"integer","format":"int32"},"nullable":true},"merchant_user_id":{"type":"integer","format":"int32","nullable":true},"start_date":{"type":"string","format":"date-time","nullable":true}}},"FulfillmentCenterInventoryService.Post.Inventory.History.Query.Cursor.Integer":{"type":"integer","format":"int32"},"FulfillmentCenterInventoryService.Ulid":{"type":"object","additionalProperties":false,"properties":{"random":{"type":"string","readOnly":true,"format":"byte","nullable":true},"time":{"type":"string","readOnly":true,"format":"date-time"}}},"FulfillmentCenterInventoryService.YukiOperationalStageEnumTypeResponse":{"type":"object","additionalProperties":false,"properties":{"description":{"type":"string","readOnly":true,"nullable":true},"id":{"type":"integer","readOnly":true,"format":"int32"}}},"Integrations.Opendock.AppointmentValidationAcceptResponse":{"type":"object","description":"Empty JSON object ({}) — refNumber validated successfully against ShipBob WROs","additionalProperties":false},"Integrations.Opendock.AppointmentValidationRejectResponse":{"type":"object","description":"Rejection payload — explains why the appointment refNumber failed WRO validation","additionalProperties":false,"required":["errorMessage"],"properties":{"errorMessage":{"type":"string","description":"Operator-visible message rendered directly in the Opendock UI on the rejected appointment"}}},"Integrations.Opendock.AppointmentValidationRequest":{"type":"object","description":"Opendock V2 Appointment Validation webhook payload","example":{"action":"create","appointmentFields":{"refNumber":"WRO 935999"},"existingAppointment":null},"additionalProperties":false,"required":["action","appointmentFields"],"properties":{"action":{"type":"string","description":"Operator action that triggered the webhook","enum":["create","update"]},"appointmentFields":{"type":"object","description":"Fields on the appointment being created or updated. On update, only changed keys are present — absence of refNumber means it was not touched.","properties":{"refNumber":{"type":"string","description":"Operator-entered reference identifier — expected to contain one or more ShipBob WRO IDs","nullable":true}}},"existingAppointment":{"type":"object","description":"On update, the prior appointment state. Null on create.","properties":{"refNumber":{"type":"string","nullable":true}},"nullable":true}}},"Inventory.CreateInventoryLotExclusionRequest":{"type":"object","example":{"expiration_date":"2019-08-24T14:15:22Z","inventory_id":0,"lot_number":"string"},"additionalProperties":false,"properties":{"expiration_date":{"type":"string","format":"date-time"},"inventory_id":{"type":"integer","format":"int32"},"lot_number":{"type":"string","nullable":true}}},"Inventory.CreateLotExclusionResponse":{"type":"object","additionalProperties":false,"properties":{"created_timestamp":{"type":"string","description":"Timestamp when the lot exclusion was created","format":"date-time"},"deleted_timestamp":{"type":"string","description":"Timestamp when the lot exclusion was deleted, null if active","format":"date-time","nullable":true},"id":{"type":"integer","description":"Unique identifier of the created lot exclusion","format":"int32"},"inventory_id":{"type":"integer","description":"Unique identifier of the inventory item","format":"int32"},"is_deleted":{"type":"boolean","description":"Whether the lot exclusion has been soft-deleted"},"lot_date":{"type":"string","description":"The date associated with the excluded lot","format":"date-time","nullable":true},"lot_number":{"type":"string","description":"The lot number excluded from fulfillment"}}},"Inventory.DeleteLotExclusionResponse":{"type":"object","additionalProperties":false,"properties":{"deleted_timestamp":{"type":"string","description":"Timestamp when the lot exclusion was deleted","format":"date-time","nullable":true},"inventory_id":{"type":"integer","description":"Unique identifier of the inventory item","format":"int32"},"is_deleted":{"type":"boolean","description":"Whether the lot exclusion has been soft-deleted"},"lot_date":{"type":"string","description":"The date associated with the lot","format":"date-time","nullable":true},"lot_number":{"type":"string","description":"The lot number of the deleted exclusion"}}},"Inventory.DimensionsResponse":{"type":"object","additionalProperties":false,"properties":{"height":{"type":"number","description":"Height measurement of the inventory item","format":"double"},"is_locked":{"type":"boolean","description":"Indicates whether dimensions are locked and cannot be modified"},"length":{"type":"number","description":"Length measurement of the inventory item","format":"double"},"unit":{"type":"string","description":"Unit of measurement for dimensions (i.e. inches)","nullable":true},"validated":{"type":"boolean","description":"Indicates whether dimensions have been validated by warehouse staff"},"width":{"type":"number","description":"Width measurement of the inventory item","format":"double"}}},"Inventory.FilterOperati":{"type":"object","additionalProperties":false,"properties":{"key":{"type":"string","nullable":true},"rawValue":{"type":"string","nullable":true}}},"Inventory.FilterOperation":{"type":"object","additionalProperties":false,"properties":{"key":{"type":"string","description":"Filter field name to apply the operation to (e.g., 'sku', 'name', 'is_active')","nullable":true},"rawValue":{"type":"string","description":"Filter value to match against the specified field","nullable":true}}},"Inventory.FilterOperationArray":{"type":"array","description":"Advanced filtering operations. Apply multiple key-value filters to refine inventory results. Each filter operation contains a 'key' (field name) and 'rawValue' (filter value) to match.","items":{"$ref":"#/components/schemas/Inventory.FilterOperation"}},"Inventory.FulfillableQuantityByFulfillmentCenter":{"type":"object","additionalProperties":false,"properties":{"awaiting_quantity":{"type":"integer","description":"Quantity expected to arrive at this location","format":"int32"},"committed_quantity":{"type":"integer","description":"Quantity reserved for existing orders at this location","format":"int32"},"fulfillable_quantity":{"type":"integer","description":"Quantity available to fulfill new orders at this location","format":"int32"},"internal_transfer_quantity":{"type":"integer","description":"Quantity in transit to or from this location","format":"int32"},"location_id":{"type":"integer","description":"Unique identifier for the fulfillment center location","format":"int32"},"name":{"type":"string","description":"Name of the fulfillment center","nullable":true},"on_hand_quantity":{"type":"integer","description":"Total quantity physically present at this location","format":"int32"}}},"Inventory.FulfillableQuantityByFulfillmentCenterV4":{"type":"object","additionalProperties":false,"properties":{"awaiting_quantity":{"type":"integer","format":"int32"},"committed_quantity":{"type":"integer","format":"int32"},"damaged_quantity":{"type":"integer","format":"int32"},"exception_quantity":{"type":"integer","format":"int32"},"fulfillable_quantity":{"type":"integer","format":"int32"},"in_fulfillment_quantity":{"type":"integer","format":"int32"},"internal_transfer_quantity":{"type":"integer","format":"int32"},"location_id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"on_hand_quantity":{"type":"integer","format":"int32"},"quarantine_quantity":{"type":"integer","format":"int32"},"userId":{"type":"integer","format":"int32"}}},"Inventory.FulfillmentCenterResponse":{"type":"object","additionalProperties":false,"properties":{"awaiting_quantity":{"type":"integer","description":"Quantity expected to arrive at this location","format":"int32"},"committed_quantity":{"type":"integer","description":"Quantity reserved for existing orders at this location","format":"int32"},"fulfillable_quantity":{"type":"integer","description":"Quantity available to fulfill new orders at this location","format":"int32"},"internal_transfer_quantity":{"type":"integer","description":"Quantity in transit to or from this location","format":"int32"},"location_id":{"type":"integer","description":"Unique identifier for the fulfillment center location","format":"int32"},"name":{"type":"string","description":"Name of the fulfillment center","nullable":true},"on_hand_quantity":{"type":"integer","description":"Total quantity physically present at this location","format":"int32"}}},"Inventory.FulfillmentCenterV4Response":{"type":"object","additionalProperties":false,"properties":{"awaiting_quantity":{"type":"integer","format":"int32"},"committed_quantity":{"type":"integer","format":"int32"},"damaged_quantity":{"type":"integer","format":"int32"},"exception_quantity":{"type":"integer","format":"int32"},"fulfillable_quantity":{"type":"integer","format":"int32"},"in_fulfillment_quantity":{"type":"integer","format":"int32"},"internal_transfer_quantity":{"type":"integer","format":"int32"},"location_id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"on_hand_quantity":{"type":"integer","format":"int32"},"quarantine_quantity":{"type":"integer","format":"int32"},"userId":{"type":"integer","format":"int32"}}},"Inventory.Get.Api.V2.Inventories.InventoryId.InventoryId.Integer":{"type":"integer","format":"int32"},"Inventory.Get.Api.V2.Inventories.InventoryIds.IntegerArray":{"type":"array","items":{"type":"integer","format":"int32"}},"Inventory.Get.Api.V2.Inventories.IsActive.Boolea":{"type":"boolean"},"Inventory.Get.Api.V2.Inventories.IsActive.Boolean":{"type":"boolean"},"Inventory.Get.Api.V2.Inventories.IsDigital.Boolea":{"type":"boolean"},"Inventory.Get.Api.V2.Inventories.IsDigital.Boolean":{"type":"boolean"},"Inventory.Get.Api.V2.Inventories.PageSize.Integer":{"type":"integer","format":"int32"},"Inventory.Get.Api.V2.Inventories.SearchBy.String":{"type":"string"},"Inventory.Get.Api.V2.Inventories.SortBy.String":{"type":"string"},"Inventory.Get.Api.V2.Inventory.Levels.InventoryId.InventoryId.Integer":{"type":"integer","format":"int32"},"Inventory.Get.Api.V2.Inventory.Levels.InventoryId.Locations.InventoryId.Integer":{"type":"integer","format":"int32"},"Inventory.Get.Api.V2.Inventory.Levels.InventoryId.Lots.InventoryId.Integer":{"type":"integer","format":"int32"},"Inventory.Get.Api.V2.Inventory.Levels.InventoryIds.IntegerArray":{"type":"array","items":{"type":"integer","format":"int32"}},"Inventory.Get.Api.V2.Inventory.Levels.IsActive.Boolea":{"type":"boolean"},"Inventory.Get.Api.V2.Inventory.Levels.IsActive.Boolean":{"type":"boolean"},"Inventory.Get.Api.V2.Inventory.Levels.IsDigital.Boolea":{"type":"boolean"},"Inventory.Get.Api.V2.Inventory.Levels.IsDigital.Boolean":{"type":"boolean"},"Inventory.Get.Api.V2.Inventory.Levels.Locations.InventoryIds.IntegerArray":{"type":"array","items":{"type":"integer","format":"int32"}},"Inventory.Get.Api.V2.Inventory.Levels.Locations.IsActive.Boolea":{"type":"boolean"},"Inventory.Get.Api.V2.Inventory.Levels.Locations.IsActive.Boolean":{"type":"boolean"},"Inventory.Get.Api.V2.Inventory.Levels.Locations.IsDigital.Boolea":{"type":"boolean"},"Inventory.Get.Api.V2.Inventory.Levels.Locations.IsDigital.Boolean":{"type":"boolean"},"Inventory.Get.Api.V2.Inventory.Levels.Locations.LocationId.Integer":{"type":"integer","format":"int32"},"Inventory.Get.Api.V2.Inventory.Levels.Locations.LocationType.String":{"type":"string"},"Inventory.Get.Api.V2.Inventory.Levels.Locations.PageSize.Integer":{"type":"integer","format":"int32"},"Inventory.Get.Api.V2.Inventory.Levels.Locations.SearchBy.String":{"type":"string"},"Inventory.Get.Api.V2.Inventory.Levels.Locations.SortBy.String":{"type":"string"},"Inventory.Get.Api.V2.Inventory.Levels.Lots.InventoryIds.IntegerArray":{"type":"array","items":{"type":"integer","format":"int32"}},"Inventory.Get.Api.V2.Inventory.Levels.Lots.IsActive.Boolea":{"type":"boolean"},"Inventory.Get.Api.V2.Inventory.Levels.Lots.IsActive.Boolean":{"type":"boolean"},"Inventory.Get.Api.V2.Inventory.Levels.Lots.IsDigital.Boolea":{"type":"boolean"},"Inventory.Get.Api.V2.Inventory.Levels.Lots.IsDigital.Boolean":{"type":"boolean"},"Inventory.Get.Api.V2.Inventory.Levels.Lots.LocationId.Integer":{"type":"integer","format":"int32"},"Inventory.Get.Api.V2.Inventory.Levels.Lots.PageSize.Integer":{"type":"integer","format":"int32"},"Inventory.Get.Api.V2.Inventory.Levels.Lots.SearchBy.String":{"type":"string"},"Inventory.Get.Api.V2.Inventory.Levels.Lots.SortBy.String":{"type":"string"},"Inventory.Get.Api.V2.Inventory.Levels.PageSize.Integer":{"type":"integer","format":"int32"},"Inventory.Get.Api.V2.Inventory.Levels.SearchBy.String":{"type":"string"},"Inventory.Get.Api.V2.Inventory.Levels.SortBy.String":{"type":"string"},"Inventory.Get.Api.V3.Inventories.InventoryId.InventoryId.Integer":{"type":"integer","description":"Unique identifier for the inventory item to retrieve. This ID is returned when listing all inventories and is used to fetch detailed information about a specific inventory item.","format":"int32"},"Inventory.Get.Api.V3.Inventories.InventoryIds.IntegerArray":{"type":"array","description":"Comma-separated list of inventory IDs to filter results. Use this to retrieve information for specific inventory items only.","items":{"type":"integer","format":"int32"}},"Inventory.Get.Api.V3.Inventories.IsActive.Boolean":{"type":"boolean","description":"Filter by active status. True returns only active inventory items, False returns only inactive items. Omit to return both."},"Inventory.Get.Api.V3.Inventories.IsDigital.Boolean":{"type":"boolean","description":"Filter by digital product status. True returns only digital products (no physical fulfillment), False returns only physical products. Omit to return both."},"Inventory.Get.Api.V3.Inventories.PageSize.Integer":{"type":"integer","description":"Number of items to return per page. Controls pagination size for the response.","format":"int32"},"Inventory.Get.Api.V3.Inventories.SearchBy.String":{"type":"string","description":"Search is available for 3 fields: Inventory ID, Name, and SKU. Expected behavior for search by Inventory ID is exact match. Expected behavior for search by Inventory Name or SKU is partial match (consecutive characters, case insensitive)."},"Inventory.Get.Api.V3.Inventories.SortBy.String":{"type":"string","description":"Sort results by field name. Results are returned in ascending order by default; append ' desc' to a field for descending order (e.g., 'name desc' sorts by name descending)."},"Inventory.Get.Api.V3.Inventory.Levels.InventoryId.InventoryId.Integer":{"type":"integer","description":"Unique identifier for the inventory item to retrieve quantity levels for. Use this to get aggregated inventory levels across all locations for a specific item.","format":"int32"},"Inventory.Get.Api.V3.Inventory.Levels.InventoryId.Locations.InventoryId.Integer":{"type":"integer","description":"Unique identifier for the inventory item to retrieve location-grouped quantity levels for. Use this to see inventory breakdown by fulfillment center.","format":"int32"},"Inventory.Get.Api.V3.Inventory.Levels.InventoryId.Lots.InventoryId.Integer":{"type":"integer","description":"Unique identifier for the inventory item to retrieve lot-grouped quantity levels for. Use this to see inventory breakdown by lot number and expiration date.","format":"int32"},"Inventory.Get.Api.V3.Inventory.Levels.InventoryIds.IntegerArray":{"type":"array","description":"Comma-separated list of inventory IDs to filter results. Use this to retrieve inventory levels for specific inventory items only.","items":{"type":"integer","format":"int32"}},"Inventory.Get.Api.V3.Inventory.Levels.IsActive.Boolean":{"type":"boolean","description":"Filter inventory levels by active status. Set to true to return only active inventory items, false for inactive items. Omit to return all items regardless of status."},"Inventory.Get.Api.V3.Inventory.Levels.IsDigital.Boolean":{"type":"boolean","description":"Filter inventory levels by digital product status. Set to true to return only digital products, false for physical products. Digital products are items that don't require physical fulfillment."},"Inventory.Get.Api.V3.Inventory.Levels.Locations.InventoryIds.IntegerArray":{"type":"array","description":"Comma-separated list of inventory IDs to filter results. Use this to retrieve location-grouped inventory levels for specific inventory items only.","items":{"type":"integer","format":"int32"}},"Inventory.Get.Api.V3.Inventory.Levels.Locations.IsActive.Boolean":{"type":"boolean","description":"Filter inventory levels by active status. Set to true to return only active inventory items, false for inactive items. Omit to return all items regardless of status."},"Inventory.Get.Api.V3.Inventory.Levels.Locations.IsDigital.Boolean":{"type":"boolean","description":"Filter inventory levels by digital product status. Set to true to return only digital products, false for physical products. Digital products are items that don't require physical fulfillment."},"Inventory.Get.Api.V3.Inventory.Levels.Locations.LocationId.Integer":{"type":"integer","description":"Filter by specific fulfillment center location ID. Use this to retrieve inventory levels for a particular fulfillment center.","format":"int32"},"Inventory.Get.Api.V3.Inventory.Levels.Locations.LocationType.String":{"type":"string","description":"Filter by location type. Valid values: 'hub', 'spoke', or 'lts'. Defaults to all locations if not specified."},"Inventory.Get.Api.V3.Inventory.Levels.Locations.PageSize.Integer":{"type":"integer","description":"Number of location-grouped inventory level items to return per page. Controls pagination size for the response.","format":"int32"},"Inventory.Get.Api.V3.Inventory.Levels.Locations.SearchBy.String":{"type":"string","description":"Search is available for 3 fields: Inventory ID, Name, and SKU. Expected behavior for search by Inventory ID is exact match. Expected behavior for search by Inventory Name or SKU is partial match (consecutive characters, case insensitive)."},"Inventory.Get.Api.V3.Inventory.Levels.Locations.SortBy.String":{"type":"string","description":"Sort results by field name. Results are returned in ascending order by default; append ' desc' to a field for descending order (e.g., 'name desc' sorts by name descending)."},"Inventory.Get.Api.V3.Inventory.Levels.Lots.InventoryIds.IntegerArray":{"type":"array","description":"Comma-separated list of inventory IDs to filter results. Use this to retrieve lot-grouped inventory levels for specific inventory items only.","items":{"type":"integer","format":"int32"}},"Inventory.Get.Api.V3.Inventory.Levels.Lots.IsActive.Boolean":{"type":"boolean","description":"Filter inventory levels by active status. Set to true to return only active inventory items, false for inactive items. Omit to return all items regardless of status."},"Inventory.Get.Api.V3.Inventory.Levels.Lots.IsDigital.Boolean":{"type":"boolean","description":"Filter inventory levels by digital product status. Set to true to return only digital products, false for physical products. Digital products are items that don't require physical fulfillment."},"Inventory.Get.Api.V3.Inventory.Levels.Lots.LocationId.Integer":{"type":"integer","description":"Filter by specific fulfillment center location ID. Use this to retrieve lot-based inventory levels for a particular warehouse or distribution center.","format":"int32"},"Inventory.Get.Api.V3.Inventory.Levels.Lots.PageSize.Integer":{"type":"integer","description":"Number of lot-grouped inventory level items to return per page. Controls pagination size for the response.","format":"int32"},"Inventory.Get.Api.V3.Inventory.Levels.Lots.SearchBy.String":{"type":"string","description":"Search is available for 3 fields: Inventory ID, Name, and SKU. Expected behavior for search by Inventory ID is exact match. Expected behavior for search by Inventory Name or SKU is partial match (consecutive characters, case insensitive)."},"Inventory.Get.Api.V3.Inventory.Levels.Lots.SortBy.String":{"type":"string","description":"Sort results by field name. Results are returned in ascending order by default; append ' desc' to a field for descending order (e.g., 'lot_date desc' sorts by lot date descending)."},"Inventory.Get.Api.V3.Inventory.Levels.PageSize.Integer":{"type":"integer","description":"Number of inventory level items to return per page. Controls pagination size for the response.","format":"int32"},"Inventory.Get.Api.V3.Inventory.Levels.SearchBy.String":{"type":"string","description":"Search is available for 3 fields: Inventory ID, Name, and SKU. Expected behavior for search by Inventory ID is exact match. Expected behavior for search by Inventory Name or SKU is partial match (consecutive characters, case insensitive)."},"Inventory.Get.Api.V3.Inventory.Levels.SortBy.String":{"type":"string","description":"Sort results by field name. Results are returned in ascending order by default; append ' desc' to a field for descending order (e.g., 'total_on_hand_quantity desc' sorts by quantity descending)."},"Inventory.Get.Api.V4.Inventory.Levels.InventoryId.InventoryId.Integer":{"type":"integer","format":"int32"},"Inventory.Get.Api.V4.Inventory.Levels.InventoryId.Locations.InventoryId.Integer":{"type":"integer","format":"int32"},"Inventory.Get.Api.V4.Inventory.Levels.InventoryId.Lots.InventoryId.Integer":{"type":"integer","format":"int32"},"Inventory.Get.Api.V4.Inventory.Levels.InventoryIds.IntegerArray":{"type":"array","description":"Comma-separated list of inventory IDs to filter results. Use this to retrieve inventory levels for specific inventory items only.","items":{"type":"integer","format":"int32"}},"Inventory.Get.Api.V4.Inventory.Levels.IsActive.Boolean":{"type":"boolean","description":"Filter inventory levels by active status. Set to true to return only active inventory items, false for inactive items. Omit to return all items regardless of status."},"Inventory.Get.Api.V4.Inventory.Levels.IsDigital.Boolean":{"type":"boolean","description":"Filter inventory levels by digital product status. Set to true to return only digital products, false for physical products. Digital products are items that don't require physical fulfillment."},"Inventory.Get.Api.V4.Inventory.Levels.Locations.InventoryIds.IntegerArray":{"type":"array","items":{"type":"integer","format":"int32"}},"Inventory.Get.Api.V4.Inventory.Levels.Locations.IsActive.Boolean":{"type":"boolean"},"Inventory.Get.Api.V4.Inventory.Levels.Locations.IsDigital.Boolean":{"type":"boolean"},"Inventory.Get.Api.V4.Inventory.Levels.Locations.LocationId.Integer":{"type":"integer","format":"int32"},"Inventory.Get.Api.V4.Inventory.Levels.Locations.LocationType.String":{"type":"string"},"Inventory.Get.Api.V4.Inventory.Levels.Locations.PageSize.Integer":{"type":"integer","format":"int32"},"Inventory.Get.Api.V4.Inventory.Levels.Locations.SearchBy.String":{"type":"string"},"Inventory.Get.Api.V4.Inventory.Levels.Locations.SortBy.String":{"type":"string"},"Inventory.Get.Api.V4.Inventory.Levels.Lots.InventoryIds.IntegerArray":{"type":"array","items":{"type":"integer","format":"int32"}},"Inventory.Get.Api.V4.Inventory.Levels.Lots.IsActive.Boolean":{"type":"boolean"},"Inventory.Get.Api.V4.Inventory.Levels.Lots.IsDigital.Boolean":{"type":"boolean"},"Inventory.Get.Api.V4.Inventory.Levels.Lots.LocationId.Integer":{"type":"integer","format":"int32"},"Inventory.Get.Api.V4.Inventory.Levels.Lots.PageSize.Integer":{"type":"integer","format":"int32"},"Inventory.Get.Api.V4.Inventory.Levels.Lots.SearchBy.String":{"type":"string"},"Inventory.Get.Api.V4.Inventory.Levels.Lots.SortBy.String":{"type":"string"},"Inventory.Get.Api.V4.Inventory.Levels.PageSize.Integer":{"type":"integer","description":"Number of inventory level items to return per page. Controls pagination size for the response.","format":"int32"},"Inventory.Get.Api.V4.Inventory.Levels.SearchBy.String":{"type":"string","description":"Search is available for 3 fields: Inventory ID, Name, and SKU. Expected behavior for search by Inventory ID is exact match. Expected behavior for search by Inventory Name or SKU is partial match (consecutive characters, case insensitive)."},"Inventory.Get.Api.V4.Inventory.Levels.SortBy.String":{"type":"string","description":"Sort results by field name. Results are returned in ascending order by default; append ' desc' to a field for descending order (e.g., 'total_on_hand_quantity desc' sorts by quantity descending)."},"Inventory.Get.Api.V4.Lot.Exclusions.InventoryId.Integer":{"type":"integer","description":"Unique identifier of the inventory item to retrieve lot exclusions for.","format":"int32"},"Inventory.Get.Api.V4.Lot.Exclusions.Sku.String":{"type":"string","description":"SKU of the inventory item to retrieve lot exclusions for."},"Inventory.HazmatResponse":{"type":"object","additionalProperties":false,"properties":{"is_hazmat":{"type":"boolean","description":"Indicates if the inventory item is classified as hazardous material"},"validated":{"type":"boolean","description":"Indicates whether hazmat status has been validated and confirmed"}}},"Inventory.InventoryHistoryReportQueryModel":{"type":"object","example":{"endDate":"2019-08-24T14:15:22Z","fulfillmentCenterId":0,"inventoryIds":[0],"requestId":"string","startDate":"2019-08-24T14:15:22Z"},"additionalProperties":false,"properties":{"endDate":{"type":"string","description":"End date to filter orders inserted earlier than. If provided, end date must be after the start date.","format":"date-time"},"fulfillmentCenterId":{"type":"integer","description":"Fulfillment center Id to filter by.","format":"int32"},"inventoryIds":{"type":"array","description":"List of InventoryIds to filter by.","items":{"type":"integer","format":"int32"},"nullable":true},"requestId":{"type":"string","description":"RequestId to correlate the request with the response file","nullable":true},"startDate":{"type":"string","description":"Start date to filter orders inserted later than.","format":"date-time"}}},"Inventory.InventoryHistoryReportResponse":{"type":"object","additionalProperties":false,"properties":{"reportUrl":{"type":"string","description":"The publicly accessible URL to download the report","nullable":true},"requestId":{"type":"string","description":"RequestId to correlate the request with the response file","nullable":true}}},"Inventory.InventoryQuantityFcResponse":{"type":"object","additionalProperties":false,"properties":{"inventory_id":{"type":"integer","description":"Unique identifier for the inventory item","format":"int32"},"locations":{"type":"array","description":"List of fulfillment centers and their respective inventory quantities","items":{"$ref":"#/components/schemas/Inventory.FulfillmentCenterResponse"},"nullable":true},"name":{"type":"string","description":"Name of the inventory item","nullable":true},"sku":{"type":"string","description":"Stock keeping unit identifier","nullable":true}}},"Inventory.InventoryQuantityFcResponsePagedResponse":{"type":"object","additionalProperties":false,"properties":{"first":{"type":"string","description":"URL to retrieve the first page of results. Null if already on the first page.","nullable":true},"items":{"type":"array","description":"Array of location-grouped inventory quantity items in the current page of results.","items":{"$ref":"#/components/schemas/Inventory.InventoryQuantityFcResponse"},"nullable":true},"last":{"type":"string","description":"URL to retrieve the last page of results. Null if already on the last page.","nullable":true},"next":{"type":"string","description":"URL to retrieve the next page of results. Null if on the last page.","nullable":true},"prev":{"type":"string","description":"URL to retrieve the previous page of results. Null if on the first page.","nullable":true}}},"Inventory.InventoryQuantityFcV4Response":{"type":"object","additionalProperties":false,"properties":{"inventory_id":{"type":"integer","format":"int32"},"locations":{"type":"array","items":{"$ref":"#/components/schemas/Inventory.FulfillmentCenterV4Response"},"nullable":true},"name":{"type":"string","nullable":true},"sku":{"type":"string","nullable":true},"userId":{"type":"integer","format":"int32"}}},"Inventory.InventoryQuantityFcV4ResponsePagedResponse":{"type":"object","additionalProperties":false,"properties":{"first":{"type":"string","nullable":true},"items":{"type":"array","items":{"$ref":"#/components/schemas/Inventory.InventoryQuantityFcV4Response"},"nullable":true},"last":{"type":"string","nullable":true},"next":{"type":"string","nullable":true},"prev":{"type":"string","nullable":true}}},"Inventory.InventoryQuantityLotResponse":{"type":"object","additionalProperties":false,"properties":{"inventory_id":{"type":"integer","description":"Unique identifier for the inventory item","format":"int32"},"lots":{"type":"array","description":"List of lot numbers and their respective inventory quantities","items":{"$ref":"#/components/schemas/Inventory.Lots"},"nullable":true},"name":{"type":"string","description":"Name of the inventory item","nullable":true},"sku":{"type":"string","description":"Stock keeping unit identifier","nullable":true}}},"Inventory.InventoryQuantityLotResponsePagedResponse":{"type":"object","additionalProperties":false,"properties":{"first":{"type":"string","description":"URL to retrieve the first page of results. Null if already on the first page.","nullable":true},"items":{"type":"array","description":"Array of lot-grouped inventory quantity items in the current page of results.","items":{"$ref":"#/components/schemas/Inventory.InventoryQuantityLotResponse"},"nullable":true},"last":{"type":"string","description":"URL to retrieve the last page of results. Null if already on the last page.","nullable":true},"next":{"type":"string","description":"URL to retrieve the next page of results. Null if on the last page.","nullable":true},"prev":{"type":"string","description":"URL to retrieve the previous page of results. Null if on the first page.","nullable":true}}},"Inventory.InventoryQuantityLotV4Response":{"type":"object","additionalProperties":false,"properties":{"inventory_id":{"type":"integer","format":"int32"},"lots":{"type":"array","items":{"$ref":"#/components/schemas/Inventory.LotsV4"},"nullable":true},"name":{"type":"string","nullable":true},"sku":{"type":"string","nullable":true},"userId":{"type":"integer","format":"int32"}}},"Inventory.InventoryQuantityLotV4ResponsePagedResponse":{"type":"object","additionalProperties":false,"properties":{"first":{"type":"string","nullable":true},"items":{"type":"array","items":{"$ref":"#/components/schemas/Inventory.InventoryQuantityLotV4Response"},"nullable":true},"last":{"type":"string","nullable":true},"next":{"type":"string","nullable":true},"prev":{"type":"string","nullable":true}}},"Inventory.InventoryQuantityResponse":{"type":"object","additionalProperties":false,"properties":{"inventory_id":{"type":"integer","description":"Unique identifier for the inventory item","format":"int32"},"name":{"type":"string","description":"Name of the inventory item","nullable":true},"sku":{"type":"string","description":"Stock keeping unit identifier","nullable":true},"total_awaiting_quantity":{"type":"integer","description":"Total quantity expected to arrive from receiving or transfers","format":"int32"},"total_backordered_quantity":{"type":"integer","description":"Total quantity on backorder for pending shipments","format":"int32"},"total_committed_quantity":{"type":"integer","description":"Total quantity reserved for existing orders and allocations","format":"int32"},"total_exception_quantity":{"type":"integer","description":"Total quantity in exception status (damaged, lost, or under investigation)","format":"int32"},"total_fulfillable_quantity":{"type":"integer","description":"Total quantity available to fulfill new orders (on-hand minus committed)","format":"int32"},"total_internal_transfer_quantity":{"type":"integer","description":"Total quantity currently in transit between fulfillment centers","format":"int32"},"total_on_hand_quantity":{"type":"integer","description":"Total quantity physically present in all fulfillment centers","format":"int32"},"total_sellable_quantity":{"type":"integer","description":"Total quantity available for sale (fulfillable plus awaiting)","format":"int32"}}},"Inventory.InventoryQuantityResponsePagedResponse":{"type":"object","additionalProperties":false,"properties":{"first":{"type":"string","description":"URL to retrieve the first page of results. Null if already on the first page.","nullable":true},"items":{"type":"array","description":"Array of inventory quantity items in the current page of results.","items":{"$ref":"#/components/schemas/Inventory.InventoryQuantityResponse"},"nullable":true},"last":{"type":"string","description":"URL to retrieve the last page of results. Null if already on the last page.","nullable":true},"next":{"type":"string","description":"URL to retrieve the next page of results. Null if on the last page.","nullable":true},"prev":{"type":"string","description":"URL to retrieve the previous page of results. Null if on the first page.","nullable":true}}},"Inventory.InventoryQuantityV4Response":{"type":"object","additionalProperties":false,"properties":{"inventory_id":{"type":"integer","description":"Unique identifier for the inventory item","format":"int32"},"name":{"type":"string","description":"Name of the inventory item","nullable":true},"sku":{"type":"string","description":"Stock keeping unit identifier","nullable":true},"total_awaiting_quantity":{"type":"integer","description":"Total quantity expected to arrive from receiving or transfers","format":"int32"},"total_backordered_quantity":{"type":"integer","description":"Total quantity on backorder for pending shipments","format":"int32"},"total_committed_quantity":{"type":"integer","description":"Total quantity reserved for existing orders and allocations","format":"int32"},"total_damaged_quantity":{"type":"integer","description":"Total quantity currently marked as damaged","format":"int32"},"total_exception_quantity":{"type":"integer","description":"Total quantity in exception status (damaged, lost, or under investigation)","format":"int32"},"total_fulfillable_quantity":{"type":"integer","description":"Total quantity available to fulfill new orders (on-hand minus committed)","format":"int32"},"total_in_fulfillment_quantity":{"type":"integer","description":"Total quantity of inventory items that are currently in the fulfillment process","format":"int32"},"total_internal_transfer_quantity":{"type":"integer","description":"Total quantity currently in transit between fulfillment centers","format":"int32"},"total_on_hand_quantity":{"type":"integer","description":"Total quantity physically present in all fulfillment centers","format":"int32"},"total_quarantine_quantity":{"type":"integer","description":"Total quantity currently in quarantine status","format":"int32"},"total_sellable_quantity":{"type":"integer","description":"Total quantity available for sale (fulfillable plus awaiting minus quarantine minus damaged)","format":"int32"},"userId":{"type":"integer","format":"int32"}}},"Inventory.InventoryQuantityV4ResponsePagedResponse":{"type":"object","additionalProperties":false,"properties":{"first":{"type":"string","description":"URL to retrieve the first page of results. Null if already on the first page.","nullable":true},"items":{"type":"array","description":"Array of inventory quantity items in the current page of results.","items":{"$ref":"#/components/schemas/Inventory.InventoryQuantityV4Response"},"nullable":true},"last":{"type":"string","description":"URL to retrieve the last page of results. Null if already on the last page.","nullable":true},"next":{"type":"string","description":"URL to retrieve the next page of results. Null if on the last page.","nullable":true},"prev":{"type":"string","description":"URL to retrieve the previous page of results. Null if on the first page.","nullable":true}}},"Inventory.InventoryResponse":{"type":"object","additionalProperties":false,"properties":{"barcode":{"type":"string","description":"Barcode associated with the inventory item","nullable":true},"dimensions":{"description":"Physical dimensions of the inventory item","$ref":"#/components/schemas/Inventory.DimensionsResponse"},"inventory_id":{"type":"integer","description":"Unique identifier for the inventory item","format":"int32"},"is_case":{"type":"boolean","description":"Indicates if the inventory item is stored in cases"},"is_lot":{"type":"boolean","description":"Indicates if the inventory item is tracked by lot number"},"name":{"type":"string","description":"Name of the inventory item","nullable":true},"sku":{"type":"string","description":"Stock keeping unit identifier","nullable":true},"user_id":{"type":"integer","description":"User ID associated with this inventory item","format":"int32"},"variant":{"description":"Variant details including active status and product characteristics","$ref":"#/components/schemas/Inventory.VariantResponse"},"weight":{"description":"Weight information of the inventory item","$ref":"#/components/schemas/Inventory.WeightResponse"}}},"Inventory.InventoryResponsePagedResponse":{"type":"object","additionalProperties":false,"properties":{"first":{"type":"string","description":"URL to retrieve the first page of results. Null if already on the first page.","nullable":true},"items":{"type":"array","description":"Array of inventory items in the current page of results.","items":{"$ref":"#/components/schemas/Inventory.InventoryResponse"},"nullable":true},"last":{"type":"string","description":"URL to retrieve the last page of results. Null if already on the last page.","nullable":true},"next":{"type":"string","description":"URL to retrieve the next page of results. Null if on the last page.","nullable":true},"prev":{"type":"string","description":"URL to retrieve the previous page of results. Null if on the first page.","nullable":true}}},"Inventory.Lot":{"type":"object","additionalProperties":false,"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/Inventory.FulfillableQuantityByFulfillmentCenter"},"nullable":true},"lot_date":{"type":"string","format":"date-time","nullable":true},"lot_number":{"type":"string","nullable":true},"on_hand_quantity":{"type":"integer","format":"int32"}}},"Inventory.LotExclusionsResponse":{"type":"object","additionalProperties":false,"properties":{"inventory_name":{"type":"string","description":"Name of the inventory item"},"inventory_sku":{"type":"string","description":"SKU of the inventory item"},"lot_exclusions":{"type":"array","description":"List of lot exclusions for the inventory item","items":{"type":"object","additionalProperties":false,"properties":{"created_timestamp":{"type":"string","description":"Timestamp when the lot exclusion was created","format":"date-time"},"deleted_timestamp":{"type":"string","description":"Timestamp when the lot exclusion was deleted, null if active","format":"date-time","nullable":true},"id":{"type":"integer","description":"Unique identifier of the lot exclusion","format":"int32"},"inventory_id":{"type":"integer","description":"Unique identifier of the inventory item","format":"int32"},"is_deleted":{"type":"boolean","description":"Whether the lot exclusion has been soft-deleted"},"lot_date":{"type":"string","description":"The date associated with the excluded lot","format":"date-time","nullable":true},"lot_number":{"type":"string","description":"The lot number excluded from fulfillment"}}}}}},"Inventory.Lots":{"type":"object","additionalProperties":false,"properties":{"awaiting_quantity":{"type":"integer","description":"Quantity expected to arrive for this lot","format":"int32"},"committed_quantity":{"type":"integer","description":"Quantity reserved for existing orders from this lot","format":"int32"},"fulfillable_quantity":{"type":"integer","description":"Quantity available to fulfill new orders for this lot","format":"int32"},"internal_transfer_quantity":{"type":"integer","description":"Quantity in transit between locations for this lot","format":"int32"},"locations":{"type":"array","description":"Breakdown of lot quantities by fulfillment center location","items":{"$ref":"#/components/schemas/Inventory.FulfillableQuantityByFulfillmentCenter"},"nullable":true},"lot_date":{"type":"string","description":"Expiration or manufacturing date associated with this lot","format":"date-time","nullable":true},"lot_number":{"type":"string","description":"Unique lot or batch number for this inventory grouping","nullable":true},"on_hand_quantity":{"type":"integer","description":"Total quantity physically present for this lot","format":"int32"}}},"Inventory.LotsV4":{"type":"object","additionalProperties":false,"properties":{"awaiting_quantity":{"type":"integer","format":"int32"},"committed_quantity":{"type":"integer","format":"int32"},"damaged_quantity":{"type":"integer","format":"int32"},"exception_quantity":{"type":"integer","format":"int32"},"fulfillable_quantity":{"type":"integer","format":"int32"},"in_fulfillment_quantity":{"type":"integer","format":"int32"},"internal_transfer_quantity":{"type":"integer","format":"int32"},"locations":{"type":"array","items":{"$ref":"#/components/schemas/Inventory.FulfillableQuantityByFulfillmentCenterV4"},"nullable":true},"lot_date":{"type":"string","format":"date-time","nullable":true},"lot_number":{"type":"string","nullable":true},"on_hand_quantity":{"type":"integer","format":"int32"},"quarantine_quantity":{"type":"integer","format":"int32"},"userId":{"type":"integer","format":"int32"}}},"Inventory.Post.Api.Inventory.History.Report.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Inventory.Post.Api.V4.Lot.Exclusions.CreateLotExclusionRequest":{"type":"object","example":{"inventory_id":123,"lot_date":"2019-08-24T14:15:22Z","lot_number":"string","sku":"string"},"additionalProperties":false,"required":["lot_number"],"properties":{"inventory_id":{"type":"integer","description":"Unique identifier of the inventory item, either this or sku must be provided","format":"int32","nullable":true},"lot_date":{"type":"string","description":"The date associated with the lot","format":"date-time","nullable":true},"lot_number":{"type":"string","description":"The lot number to exclude from fulfillment"},"sku":{"type":"string","description":"SKU of the inventory item, either this or inventory_id must be provided","nullable":true}}},"Inventory.Post.Api.V4.Lot.Exclusions.Delete.DeleteLotExclusionRequest":{"type":"object","example":{"inventory_id":123,"lot_date":"2019-08-24T14:15:22Z","lot_number":"string","sku":"string"},"additionalProperties":false,"required":["lot_number"],"properties":{"inventory_id":{"type":"integer","description":"Unique identifier of the inventory item, either this or sku must be provided","format":"int32","nullable":true},"lot_date":{"type":"string","description":"The date associated with the lot","format":"date-time","nullable":true},"lot_number":{"type":"string","description":"The lot number of the exclusion to delete"},"sku":{"type":"string","description":"SKU of the inventory item, either this or inventory_id must be provided","nullable":true}}},"Inventory.Post.Api.V4.Lot.Exclusions.Restore.RestoreLotExclusionRequest":{"type":"object","example":{"inventory_id":123,"lot_date":"2019-08-24T14:15:22Z","lot_number":"string","sku":"string"},"additionalProperties":false,"required":["lot_number"],"properties":{"inventory_id":{"type":"integer","description":"Unique identifier of the inventory item, either this or sku must be provided","format":"int32","nullable":true},"lot_date":{"type":"string","description":"The date associated with the lot","format":"date-time","nullable":true},"lot_number":{"type":"string","description":"The lot number of the exclusion to restore"},"sku":{"type":"string","description":"SKU of the inventory item, either this or inventory_id must be provided","nullable":true}}},"Inventory.ProblemDetail":{"type":"object","additionalProperties":{"additionalProperties":false},"properties":{"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"title":{"type":"string","nullable":true},"type":{"type":"string","nullable":true}}},"Inventory.ProblemDetails":{"type":"object","additionalProperties":{"additionalProperties":false},"properties":{"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem.","nullable":true},"instance":{"type":"string","description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","nullable":true},"status":{"type":"integer","description":"The HTTP status code for this occurrence of the problem.","format":"int32","nullable":true},"title":{"type":"string","description":"A short, human-readable summary of the problem type.","nullable":true},"type":{"type":"string","description":"A URI reference that identifies the problem type. This URI should provide human-readable documentation for the problem.","nullable":true}}},"Inventory.ResponseError":{"type":"object","additionalProperties":false,"properties":{"error_message":{"type":"string","nullable":true}}},"Inventory.RestoreLotExclusionResponse":{"type":"object","additionalProperties":false,"properties":{"deleted_timestamp":{"type":"string","description":"Timestamp when the lot exclusion was deleted, null after restore","format":"date-time","nullable":true},"inventory_id":{"type":"integer","description":"Unique identifier of the inventory item","format":"int32"},"is_deleted":{"type":"boolean","description":"Whether the lot exclusion is still deleted, false after restore"},"lot_date":{"type":"string","description":"The date associated with the lot","format":"date-time","nullable":true},"lot_number":{"type":"string","description":"The lot number of the restored exclusion"}}},"Inventory.VariantResponse":{"type":"object","additionalProperties":false,"properties":{"hazmat":{"description":"Hazardous materials information","$ref":"#/components/schemas/Inventory.HazmatResponse"},"is_active":{"type":"boolean","description":"Indicates if the variant is currently active and available for fulfillment"},"is_bundle":{"type":"boolean","description":"Indicates if this item is a bundle of multiple products"},"is_digital":{"type":"boolean","description":"Indicates if this is a digital product (no physical fulfillment required)"}}},"Inventory.WeightResponse":{"type":"object","additionalProperties":false,"properties":{"unit":{"type":"string","description":"Unit of measurement for weight (e.g., pounds, kilograms)","nullable":true},"value":{"type":"number","description":"Weight value of the inventory item","format":"double"}}},"Kitting.AddAttachmentResponse":{"type":"object","description":"Response returned after successfully uploading an attachment.","additionalProperties":false,"properties":{"attachment_name":{"type":"string","description":"The name of the uploaded attachment.","nullable":true},"id":{"type":"string","description":"The unique identifier of the uploaded attachment.","nullable":true}}},"Kitting.ApiError":{"type":"object","additionalProperties":false,"properties":{"details":{"additionalProperties":false,"nullable":true},"errors":{"type":"array","items":{"type":"string"}},"message":{"type":"string"},"stackTrace":{"type":"string","nullable":true}}},"Kitting.Post.Kitting.Attachment.Request.Object":{"type":"object","additionalProperties":false,"required":["file","file_name"],"properties":{"file":{"type":"string","description":"The file to upload.","format":"binary"},"file_name":{"type":"string","description":"The file name including extension (e.g. packaging-pic.jpg)."}}},"Kitting.ProblemDetails":{"type":"object","additionalProperties":{"additionalProperties":false},"properties":{"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"title":{"type":"string","nullable":true},"type":{"type":"string","nullable":true}}},"Kitting.PublicCreateWorkOrderRequest":{"type":"object","description":"Request model for creating a kitting work order.","example":{"actions":[{"attachments":[],"data":null,"instructions":"Scan the barcode on the product before kitting","order":1,"sub_actions":[],"work_order_action_type_id":1},{"attachments":[],"data":null,"instructions":"Package items according to kit specifications","order":2,"sub_actions":[{"attachments":[{"id":"photo-001","name":"completed-kit-photo"}],"data":null,"instructions":"Take a photo of the completed kit","order":1,"work_order_action_type_id":3}],"work_order_action_type_id":2}],"end_kitted_inventory_id":42,"fulfillment_center_id":1,"line_items":[{"inventory_id":101,"quantity":10}],"lot_date":"2024-01-15T09:00:00Z","lot_number":"LOT-2024-001","quantity":10,"workorder_type":"Kitting"},"additionalProperties":false,"required":["actions","end_kitted_inventory_id","fulfillment_center_id","line_items","quantity","workorder_type"],"properties":{"actions":{"type":"array","description":"The actions (steps) to be performed for the kitting work order.","items":{"$ref":"#/components/schemas/Kitting.PublicWorkOrderActionRequest"}},"end_kitted_inventory_id":{"type":"integer","description":"The inventory identifier for the end kitted product.","format":"int32","maximum":2147483647.0,"minimum":1.0},"fulfillment_center_id":{"type":"integer","description":"The fulfillment center identifier where the work order will be processed.","format":"int32","maximum":2147483647.0,"minimum":1.0},"line_items":{"type":"array","description":"The component inventory line items for the kitting work order. Each line item's quantity represents the amount of that inventory required to produce a single kit.","items":{"$ref":"#/components/schemas/Kitting.PublicOrderLineItemRequest"}},"lot_date":{"type":"string","description":"Optional lot date for the kitting work order.","format":"date-time","nullable":true},"lot_number":{"type":"string","description":"Optional lot number for the kitting work order.","maxLength":32,"minLength":0,"nullable":true},"quantity":{"type":"integer","description":"The number of kits to produce.","format":"int32","maximum":2147483647.0,"minimum":1.0},"workorder_type":{"$ref":"#/components/schemas/Kitting.WorkOrderType"}}},"Kitting.PublicCreateWorkOrderResponse":{"type":"object","description":"Response returned after successfully creating a kitting work order.","additionalProperties":false,"properties":{"shipment_id":{"type":"integer","description":"The shipment identifier associated with the created work order.","format":"int32"}}},"Kitting.PublicKittingWorkOrderCopyRequest":{"type":"object","example":{"end_kitted_quantity":10,"fulfillment_center_id":1,"lot_date":"2024-01-15T09:00:00Z","lot_number":"LOT-2024-001","shipment_id":5001},"additionalProperties":false,"required":["fulfillment_center_id","shipment_id"],"properties":{"end_kitted_quantity":{"type":"integer","description":"Number of end-kitted units to produce. When provided, overrides both the quantity and expected quantity from the original shipment. If not provided, the original shipment's quantity and expected quantity are used.","format":"int32","maximum":2147483647.0,"minimum":1.0,"nullable":true},"fulfillment_center_id":{"type":"integer","description":"The fulfillment center id associated with the work order.","format":"int32","maximum":2147483647.0,"minimum":1.0},"lot_date":{"type":"string","description":"Lot expiration date to be associated with the work order.","format":"date-time","nullable":true},"lot_number":{"type":"string","description":"Lot number to be associated with the work order.","nullable":true},"shipment_id":{"type":"integer","description":"Id of the shipment to copy line items and details from when creating the kitting work order.","format":"int32","maximum":2147483647.0,"minimum":1.0}}},"Kitting.PublicOrderLineItemRequest":{"type":"object","description":"Represents an inventory line item in a kitting work order.","additionalProperties":false,"required":["inventory_id","quantity"],"properties":{"inventory_id":{"type":"integer","description":"The inventory identifier for this line item.","format":"int32","maximum":2147483647.0,"minimum":1.0},"quantity":{"type":"integer","description":"The quantity of this inventory item required to produce a single kit.","format":"int32","maximum":2147483647.0,"minimum":1.0}}},"Kitting.PublicWorkOrderActionAttachmentRequest":{"type":"object","description":"Represents an attachment reference for a work order action.","additionalProperties":false,"required":["id","name"],"properties":{"id":{"type":"string","description":"The unique identifier (GUID) of the previously uploaded attachment."},"name":{"type":"string","description":"The file name of the attachment including extension."}}},"Kitting.PublicWorkOrderActionRequest":{"type":"object","description":"Represents an action (step) in a kitting work order.","additionalProperties":false,"required":["order","work_order_action_type_id"],"properties":{"attachments":{"type":"array","description":"Attachments associated with this action step.","items":{"$ref":"#/components/schemas/Kitting.PublicWorkOrderActionAttachmentRequest"},"nullable":true},"data":{"description":"The action-specific data payload (e.g. packaging or inventory identifiers).","additionalProperties":false,"nullable":true},"instructions":{"type":"string","description":"Optional instructions for this action step.","nullable":true},"order":{"type":"integer","description":"The sort order of this action within the work order.","format":"int32"},"sub_actions":{"type":"array","description":"Optional sub-actions nested under this action.","items":{"$ref":"#/components/schemas/Kitting.PublicWorkOrderActionRequest"},"nullable":true},"work_order_action_type_id":{"type":"integer","description":"The action type identifier that defines the kind of action to perform.","format":"int32","maximum":2147483647.0,"minimum":1.0}}},"Kitting.PublicWorkOrderActionTypeResponse":{"type":"object","description":"Represents a work order action type with its configuration and sub-actions.","additionalProperties":false,"properties":{"action_id":{"type":"integer","description":"The unique identifier for the action.","format":"int32"},"active":{"type":"boolean","description":"A value indicating whether the action is active."},"control_type":{"type":"string","description":"The control type for the action.","nullable":true},"is_root":{"type":"boolean","description":"A value indicating whether this action is a root-level action."},"name":{"type":"string","description":"The name of the action.","nullable":true},"order":{"type":"integer","description":"The display order of the action.","format":"int32","nullable":true},"sub_actions":{"type":"array","description":"List of sub-actions nested under this action.","items":{"$ref":"#/components/schemas/Kitting.PublicWorkOrderActionTypeResponse"},"nullable":true}}},"Kitting.PublicWorkOrderActionTypesResponse":{"type":"object","description":"Response containing a collection of work order action types.","additionalProperties":false,"properties":{"actions":{"type":"array","description":"The list of work order action types.","items":{"$ref":"#/components/schemas/Kitting.PublicWorkOrderActionTypeResponse"},"nullable":true}}},"Kitting.PublicWorkOrderLineItemRequest":{"type":"object","additionalProperties":false,"properties":{"inventory_id":{"type":"integer","description":"Inventory identifier to be included as a line item in the work order.","format":"int32"},"quantity":{"type":"integer","description":"Quantity to be used for the inventory in the line item for the work order.","format":"int32"}}},"Kitting.PublicWorkOrderShipmentIdResponse":{"type":"object","additionalProperties":false,"properties":{"shipment_id":{"type":"integer","description":"Id of the created shipment","format":"int32"}}},"Kitting.WorkOrderType":{"type":"string","enum":["Kitting"]},"Logistics.Get.Api.Batch.Batch.Id.Batch.Id.String":{"type":"string"},"Logistics.Get.Api.Batch.Batch.Id.OK.Object":{"type":"object","additionalProperties":false,"properties":{"_created_at":{"type":"string","format":"date-time"},"batch_id":{"type":"string"},"batch_number":{"type":"integer"},"count":{"type":"integer"},"orders":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"_id":{"type":"string"},"dimensions_present_in_sb":{"type":"boolean"},"label_printed":{"type":"boolean"},"merchant_id":{"type":"string"},"meta":{"type":"object","additionalProperties":false,"properties":{"customer_name":{"type":"string"},"order_id":{"type":"string"},"order_number":{"type":"string"}}},"order":{"type":"object","additionalProperties":false,"properties":{"location_id":{"type":"integer"},"measurements":{"type":"object","additionalProperties":false,"properties":{"depth_in":{"type":"number"},"length_in":{"type":"number"},"total_weight_oz":{"type":"number"},"width_in":{"type":"number"}}},"products":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"quantity":{"type":"integer"},"sku":{"type":"string"}}}},"recipient":{"type":"object","additionalProperties":false,"properties":{"address":{"type":"object","additionalProperties":false,"properties":{"address1":{"type":"string"},"address2":{"type":"string"},"city":{"type":"string"},"country":{"type":"string"},"state":{"type":"string"},"zip_code":{"type":"string"}}},"name":{"type":"string"}}},"reference_id":{"type":"string"},"shipping_method":{"type":"string"}}},"sb_created":{"type":"boolean"},"sb_created_At":{"type":"string","format":"date-time"},"shipment_id":{"type":"integer"}}}},"products":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"quantity":{"type":"integer"},"sku":{"type":"string"}}}}}},"Logistics.Get.Api.Batches.Batch.Printed.Boolean":{"type":"boolean"},"Logistics.Get.Api.Batches.OK.Object":{"type":"object","additionalProperties":false,"properties":{"batches":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"_created_at":{"type":"string","format":"date-time"},"_id":{"type":"string"},"_updated_at":{"type":"string","format":"date-time"},"batch_number":{"type":"integer"},"merchant_id":{"type":"string"},"number_of_orders":{"type":"integer"},"products":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"quantity":{"type":"integer"},"sku":{"type":"string"}}}},"products_hash":{"type":"string"},"shipment_ids":{"type":"array","items":{"type":"integer"}}}}},"count":{"type":"integer"},"last_refreshed_at":{"type":"string","format":"date-time"}}},"Logistics.Get.Api.Batches.Page.Integer":{"type":"integer"},"Logistics.Get.Api.Batches.Page.Size.Integer":{"type":"integer"},"Logistics.Get.Api.Batches.Sort.Object":{"type":"object","additionalProperties":false},"Logistics.Get.Api.Order.GetFilters.OK.Object":{"type":"object","additionalProperties":false,"properties":{"store":{"type":"object","additionalProperties":false,"properties":{"data":{"type":"array","items":{"type":"string"}},"display_name":{"type":"string"}}}}},"Logistics.Get.Api.Order.Is.Final.Mile.Label.Boolean":{"type":"boolean"},"Logistics.Get.Api.Order.Label.Printed.String":{"type":"string"},"Logistics.Get.Api.Order.Page.Integer":{"type":"integer"},"Logistics.Get.Api.Order.Page.Size.Integer":{"type":"integer"},"Logistics.Get.Api.Order.Printed.Date.String":{"type":"string","format":"DD/MM/YYYY"},"Logistics.Get.Api.Order.Reference.Id.Reference.Id.String":{"type":"string"},"Logistics.Get.Api.Order.Search.Search.Term.String":{"type":"string"},"Logistics.Get.Api.Order.Search.Term.String":{"type":"string"},"Logistics.Get.Api.Order.Status.String":{"type":"string"},"Logistics.Get.Api.Order.Stores.String":{"type":"string"},"Logistics.Order":{"type":"object","example":{"meta":{"customer_name":"string","order_id":"string","order_number":"string"},"order":{"location_id":0,"measurements":{"depth_in":0,"length_in":0,"total_weight_oz":0,"width_in":0},"products":[{"name":"string","quantity":0,"sku":"string"}],"recipient":{"address":{"address1":"string","address2":"string","city":"string","country":"string","state":"string","zip_code":"string"},"email":"string","name":"string","phone_number":"string"},"reference_id":"string","shipping_method":"string"}},"additionalProperties":false,"properties":{"label_config":{"type":"object","additionalProperties":false,"properties":{"packing_slip":{"type":"boolean","example":false}}},"meta":{"type":"object","additionalProperties":false,"properties":{"customer_name":{"type":"string"},"order_id":{"type":"string"},"order_number":{"type":"string"}}},"order":{"type":"object","additionalProperties":false,"properties":{"insurance_amount":{"type":"number"},"location_id":{"type":"integer"},"measurements":{"type":"object","additionalProperties":false,"properties":{"depth_in":{"type":"number"},"length_in":{"type":"number"},"total_weight_oz":{"type":"number"},"width_in":{"type":"number"}}},"products":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"quantity":{"type":"integer"},"sku":{"type":"string"}}}},"recipient":{"type":"object","additionalProperties":false,"properties":{"address":{"type":"object","additionalProperties":false,"properties":{"address1":{"type":"string"},"address2":{"type":"string"},"city":{"type":"string"},"country":{"type":"string"},"state":{"type":"string"},"zip_code":{"type":"string"}}},"email":{"type":"string"},"name":{"type":"string"},"phone_number":{"type":"string"}}},"reference_id":{"type":"string"},"shipping_method":{"type":"string"}}}}},"Logistics.OrderArray":{"type":"array","items":{"$ref":"#/components/schemas/Logistics.Order"}},"Logistics.Post.Api.Order.Bulk.Cancel.OK.Object":{"type":"object","additionalProperties":false,"properties":{"is_cancelled":{"type":"boolean","example":true},"reason":{"type":"string","example":"Order is already Cancelled."},"reference_id":{"type":"string","example":"ONpAfKMHa5W"}}},"Logistics.Post.Api.Order.Bulk.Cancel.Request.Object":{"type":"object","example":{"reference_ids":["ONpAfKMHa5W","Q05ENiS1soL"]},"additionalProperties":false,"properties":{"reference_ids":{"type":"array","description":"List of reference IDs of the orders to cancel","example":["ONpAfKMHa5W","Q05ENiS1soL"],"items":{"type":"string"}}}},"Logistics.Post.Api.Order.CreateLabel.Label.Type.String":{"type":"string","enum":["application/pdf"]},"Logistics.Post.Api.Order.CreateLabel.OK.Object":{"type":"object","additionalProperties":false,"properties":{"interim_order_id":{"type":"string"},"label":{"type":"string"},"reference_id":{"type":"string"},"shipment_id":{"type":"integer"}}},"Logistics.Post.Api.Order.Created.Object":{"type":"object","additionalProperties":false,"properties":{"interim_order_id":{"type":"string"},"reference_id":{"type":"string"},"shipment_id":{"type":"integer"}}},"Logistics.Post.Api.Order.GenerateLabel.Bad.Request.Object":{"type":"object","additionalProperties":false,"properties":{"error":{"type":"string","example":"Invalid request parameters"}}},"Logistics.Post.Api.Order.GenerateLabel.Internal.Server.Error.Object":{"type":"object","additionalProperties":false,"properties":{"error":{"type":"string","example":"Unexpected error occurred"}}},"Logistics.Post.Api.Order.GenerateLabel.Label.Type.String":{"type":"string","enum":["application/pdf"]},"Logistics.Post.Api.Order.GenerateLabel.OK.Object":{"type":"object","additionalProperties":false,"properties":{"label_url":{"type":"string","description":"URL to access the generated label","example":"https://storage.example.com/labels/ORD-12345.pdf"}}},"Logistics.Post.Api.Order.GenerateLabel.Request.Object":{"type":"object","example":{"packing_slip":false,"reference_id":"ORD-12345"},"additionalProperties":false,"required":["reference_id"],"properties":{"packing_slip":{"type":"boolean","description":"Whether to include packing slip","default":false,"example":false},"reference_id":{"type":"string","description":"Unique identifier for the order","example":"ORD-12345"}}},"Logistics.Post.Api.Order.Request.Object":{"type":"object","example":{"meta":{"customer_name":"Albert Einstein","order_id":"def456","order_number":"xyz789"},"order":{"insurance_amount":"150.00","location_id":72,"products":[{"name":"spinner-green","quantity":15,"sku":"s-g"}],"recipient":{"address":{"address1":"123 Main St","address2":"Apt 4B","city":"Chicago","country":"US","state":"IL","zip_code":60607},"email":"einstein@example.com","name":"Einstein","phone_number":1234567890},"reference_id":"abc123","shipping_method":"Standard"}},"additionalProperties":false,"properties":{"meta":{"type":"object","additionalProperties":false,"properties":{"customer_name":{"type":"string","example":"Albert Einstein"},"order_id":{"type":"string","example":"def456"},"order_number":{"type":"string","example":"xyz789"}}},"order":{"type":"object","additionalProperties":false,"properties":{"insurance_amount":{"type":"number","example":100},"location_id":{"type":"integer","example":72},"products":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","example":"spinner-green"},"quantity":{"type":"integer","example":15},"sku":{"type":"string","example":"s-g"}}}},"recipient":{"type":"object","additionalProperties":false,"properties":{"address":{"type":"object","additionalProperties":false,"properties":{"address1":{"type":"string","example":"123 Main St"},"address2":{"type":"string","example":"Apt 4B"},"city":{"type":"string","example":"Chicago"},"country":{"type":"string","example":"US"},"state":{"type":"string","example":"IL"},"zip_code":{"type":"string","example":60607}}},"email":{"type":"string","example":"einstein@example.com"},"name":{"type":"string","example":"Einstein"},"phone_number":{"type":"string","example":1234567890}}},"reference_id":{"type":"string","example":"abc123"},"shipping_method":{"type":"string","example":"Standard"}}}}},"Logistics.Post.Api.Picklist.Request.Object":{"type":"object","example":{"orders":["string"]},"additionalProperties":false,"properties":{"orders":{"type":"array","description":"List of order reference IDs to generate the picklist for","items":{"type":"string"}}}},"Logistics.Post.Api.Rate.Shopping.OK.Object":{"type":"object","additionalProperties":false,"properties":{"data":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"errorMessage":{"type":"string","example":""},"flatRate":{"type":"number","example":18.95},"flatRateCurrencyCode":{"type":"string","example":"USD"},"insuranceCharges":{"type":"number","description":"The insurance Charges for the package (USD)","example":400},"isSuccess":{"type":"boolean","example":true},"shipOptionDisplayName":{"type":"string","example":"Standard (Ground)"},"shippingServiceDescription":{"type":"string","example":"(USPS First Class & Priority, UPS Ground)"},"shippingServiceId":{"type":"integer","example":3},"surcharges":{"type":"object","additionalProperties":false,"properties":{"errorMessage":{"type":"string","example":""},"isSuccess":{"type":"boolean","example":true},"surcharges":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"amount":{"type":"number","example":0.45},"currencyCode":{"type":"string","example":"USD"},"name":{"type":"string","example":"Fuel Surcharge"}}}},"surchargesCurrencyCode":{"type":"string","example":"USD"},"totalSurchargesAmount":{"type":"number","example":0.45}}}}}},"errorMessage":{"type":"string","example":""},"isSuccess":{"type":"boolean","example":true}}},"Logistics.Post.Api.Rate.Shopping.Request.Object":{"type":"object","example":{"actualWeight":16.5,"destinationAddress":{"address1":"123 Main Street","address2":"Suite 4B","city":"Chicago","countryISO":"US","state":"IL","zipCode":60601},"fulfillmentCenterId":10,"hasSignature":false,"insuranceAmount":400,"packageDimensions":{"HeightInches":6,"LengthInches":12,"WidthInches":8},"serviceName":"Standard Premium"},"additionalProperties":false,"properties":{"actualWeight":{"type":"number","description":"The weight of the package in ounces","example":16.5},"destinationAddress":{"type":"object","description":"The destination address for the package","additionalProperties":false,"properties":{"address1":{"type":"string","example":"123 Main Street"},"address2":{"type":"string","example":"Suite 4B"},"city":{"type":"string","example":"Chicago"},"countryISO":{"type":"string","example":"US"},"state":{"type":"string","example":"IL"},"zipCode":{"type":"string","example":60601}}},"fulfillmentCenterId":{"type":"string","description":"The ID of the fulfillment center","example":10},"hasSignature":{"type":"boolean","description":"Whether to require signature for delivery (optional, auto-set to true if insurance >= 300)","example":false},"insuranceAmount":{"type":"number","description":"The insurance amount for the package (USD). Values >= 300 will require signature","minimum":0.0,"example":400},"packageDimensions":{"type":"object","description":"The dimensions of the package","additionalProperties":false,"properties":{"HeightInches":{"type":"number","example":6},"LengthInches":{"type":"number","example":12},"WidthInches":{"type":"number","example":8}}},"serviceName":{"type":"string","description":"The name of the shipping service","example":"Standard Premium"}}},"Logistics.Put.Api.Batch.Marklabelprinted.OK.Object":{"type":"object","additionalProperties":false,"properties":{"batch_id":{"type":"string","example":"60f7c0f5e1b1c8a1d4e8b123"},"printed_at":{"type":"string","format":"date-time","example":"2025-05-16T12:34:56.789Z"}}},"Logistics.Put.Api.Batch.Marklabelprinted.Request.Object":{"type":"object","example":{"batch_id":"60f7c0f5e1b1c8a1d4e8b123"},"additionalProperties":false,"properties":{"batch_id":{"type":"string","description":"The unique ID of the batch to mark as printed","example":"60f7c0f5e1b1c8a1d4e8b123"}}},"Logistics.Put.Api.Order.Marklabelprinted.OK.Object":{"type":"object","additionalProperties":false,"properties":{"_id":{"type":"string","example":"60f7c0f5e1b1c8a1d4e8b123"},"label_printed":{"type":"boolean","example":true},"printed_date":{"type":"string","format":"date-time","example":"2025-05-16T12:34:56.789Z"},"updated_At":{"type":"string","format":"date-time","example":"2025-05-16T12:34:56.789Z"}}},"Logistics.Put.Api.Order.Marklabelprinted.Request.Object":{"type":"object","example":{"_id":"string","is_final_mile_label":false},"additionalProperties":false,"properties":{"_id":{"type":"string","description":"The unique ID of the order"},"is_final_mile_label":{"type":"boolean","description":"Flag to indicate if this is a final mile label"}}},"Logistics.Put.Api.Order.Reference.Id.Dimensions.Reference.Id.String":{"type":"string"},"Logistics.Put.Api.Order.Reference.Id.Dimensions.Request.Object":{"type":"object","example":{"depth_in":12,"length_in":10,"total_weight_oz":15,"width_in":10},"additionalProperties":false,"properties":{"depth_in":{"type":"number","example":12},"length_in":{"type":"number","example":10},"total_weight_oz":{"type":"number","example":15},"width_in":{"type":"number","example":10}}},"Orders.AddressType":{"type":"string","enum":["MarkFor","ShipFrom"]},"Orders.AddressViewModel":{"type":"object","required":["address1","city","country"],"properties":{"address1":{"type":"string","description":"First line of the address","minLength":1,"example":"100 Nowhere Blvd"},"address2":{"type":"string","description":"Second line of the address","example":"Suite 100","nullable":true},"city":{"type":"string","description":"The city","minLength":1,"example":"Gotham City"},"company_name":{"type":"string","description":"Name of the company receiving the shipment","example":"Wayne Enterprises","nullable":true},"country":{"type":"string","description":"The country (Must be ISO Alpha-2 for estimates)","minLength":1,"example":"US"},"state":{"type":"string","description":"The state or province","example":"NJ","nullable":true},"zip_code":{"type":"string","description":"The zip code or postal code","format":"postal-code","example":"07093","nullable":true}}},"Orders.CreateTransportationOrderModel":{"type":"object","example":{"location_id":0,"measurements":{"depth_in":0,"length_in":0,"total_weight_oz":0,"width_in":0},"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","shipping_method":"Free 2-day Shipping"},"additionalProperties":false,"required":["locationId","measurements","recipient","referenceId","shippingMethod"],"properties":{"location_id":{"type":"integer","description":"Desired Fulfillment Center Location ID. If not specified, ShipBob will determine the location that fulfills this order.","format":"int32"},"measurements":{"$ref":"#/components/schemas/Orders.MeasurementsViewModel"},"recipient":{"$ref":"#/components/schemas/Orders.RecipientInfoViewModel"},"reference_id":{"type":"string","description":"Unique and immutable order identifier from your upstream system","maxLength":300,"minLength":1},"shipping_method":{"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","minLength":1,"example":"Free 2-day Shipping"}}},"Orders.Get.Api.LotExclusions.Inventory.Id.Integer":{"type":"integer","format":"int32"},"Orders.Get.Api.LotExclusions.InventoryLotExclusionsViewModel":{"type":"object","additionalProperties":false,"properties":{"exclusions":{"type":"array","items":{"$ref":"#/components/schemas/Orders.Get.Api.LotExclusions.LotExclusionsViewModel"}},"inventory_id":{"type":"integer","description":"Inventory ID for excluded lot","format":"int32"}}},"Orders.Get.Api.LotExclusions.InventoryLotExclusionsViewModelArray":{"type":"array","items":{"$ref":"#/components/schemas/Orders.Get.Api.LotExclusions.InventoryLotExclusionsViewModel"}},"Orders.Get.Api.LotExclusions.LotDate.String":{"type":"string","format":"date-time"},"Orders.Get.Api.LotExclusions.LotExclusionsViewModel":{"type":"object","additionalProperties":false,"properties":{"location_id":{"type":"integer","description":"Id of location","format":"int32"},"lot_date":{"type":"string","description":"Lot date","format":"date-time","nullable":true},"lot_number":{"type":"string","description":"Lot number","nullable":true},"quantity":{"type":"integer","description":"Quantity available from excluded lot at location","format":"int32"}}},"Orders.Get.Api.LotExclusions.LotExclusionsViewModelArray":{"type":"array","items":{"$ref":"#/components/schemas/Orders.Get.Api.LotExclusions.LotExclusionsViewModel"}},"Orders.Get.Api.LotExclusions.LotNumber.String":{"type":"string"},"Orders.Get.Api.LotExclusions.Shipbob.Channel.Id.Integer":{"type":"integer","format":"int32"},"Orders.MeasurementsViewModel":{"type":"object","description":"Measurements of a shipment","additionalProperties":false,"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"}}},"Orders.Post.Api.Order.Transportation.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Orders.Post.Api.Order.Transportation.Shipbob.Channel.Id.Integer":{"type":"integer","format":"int32"},"Orders.Post.Api.Order.Transportation.Unprocessable.Entity.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Orders.Put.Api.Order.OrderId.Dimensions.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Orders.Put.Api.Order.OrderId.Dimensions.OrderId.Integer":{"type":"integer","format":"int32"},"Orders.Put.Api.Order.OrderId.Dimensions.Shipbob.Channel.Id.Integer":{"type":"integer","format":"int32"},"Orders.Put.Api.Order.OrderId.Dimensions.Unprocessable.Entity.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Orders.RecipientInfoViewModel":{"type":"object","description":"Information about the recipient of an order","additionalProperties":false,"required":["address","name"],"properties":{"address":{"description":"Address of the recipient","oneOf":[{"$ref":"#/components/schemas/Orders.AddressViewModel"},{"$ref":"#/components/schemas/Orders.RetailerProgramDataAddressViewModel"}]},"email":{"type":"string","description":"Email address of the recipient","format":"email","example":"john@example.com","nullable":true},"name":{"type":"string","description":"Name of the recipient","maxLength":300,"minLength":1,"example":"John Doe"},"phone_number":{"type":"string","description":"Phone number of the recipient","maxLength":50,"example":"555-555-5555","nullable":true}}},"Orders.RetailerProgramDataAddressViewModel":{"type":"object","description":"Address to used when creating a B2B/DropShip order.","required":["type"],"properties":{"type":{"$ref":"#/components/schemas/Orders.AddressType"}},"allOf":[{"$ref":"#/components/schemas/Orders.AddressViewModel"}]},"Orders.TransportationOrderViewModel":{"type":"object","additionalProperties":false,"properties":{"shipment_id":{"type":"integer","description":"Unique ID of the transportation shipment","format":"int32"}}},"Orders.UpdateMeasurementsViewModel":{"type":"object","description":"Measurements of a shipment","additionalProperties":false,"required":["depth","length","totalWeight","width"],"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"}}},"Orders.UpdateOrderDimensionsModel":{"type":"object","description":"Request schema class for transport order update endpoint","example":{"measurements":{"depth_in":0,"length_in":0,"total_weight_oz":0,"width_in":0}},"additionalProperties":false,"required":["measurements"],"properties":{"measurements":{"$ref":"#/components/schemas/Orders.UpdateMeasurementsViewModel"}}},"OrdersDataPlane.ApiCurrency":{"type":"object","description":"Represents a monetary value and its currency code.","additionalProperties":false,"properties":{"code":{"type":"string","description":"The ISO 4217 currency code.","example":"USD","nullable":true},"value":{"type":"number","description":"The amount of money.","format":"double","example":12.34}}},"OrdersDataPlane.ApiExceptionInfo":{"type":"object","description":"Represents information about an exception that occurred with an order.","additionalProperties":false,"properties":{"inventory_ids":{"type":"array","description":"A list of IDs representing inventory that are causing this exception.","example":[123,456],"items":{"type":"integer","format":"int32"},"nullable":true},"reason":{"type":"string","description":"The reason for the exception.","example":"Out of Stock","nullable":true}}},"OrdersDataPlane.ApiFulfillmentInfo":{"type":"object","description":"Contains all information related to the fulfillment of a shipment, such as timestamps of warehouse operations like picking and packing, status and location of fulfillment, lot selection type, and merchant cost. All timestamps are in UTC.","additionalProperties":false,"properties":{"allocated_at":{"type":"string","description":"The timestamp when inventory was allocated to this specific shipment.","format":"date-time","nullable":true},"fulfill_on_or_after":{"type":"string","description":"The timestamp of the earliest point a shipment should be fulfilled.","format":"date-time","nullable":true},"fulfillment_cost":{"$ref":"#/components/schemas/OrdersDataPlane.ApiCurrency"},"fulfillment_cost_applied_at":{"type":"string","format":"date-time","nullable":true},"label_applied_at":{"type":"string","description":"The timestamp when the shipping label was applied to the package.","format":"date-time","nullable":true},"label_type_id":{"type":"integer","format":"int32","nullable":true},"location":{"$ref":"#/components/schemas/OrdersDataPlane.ApiLocation"},"lot_selection_method":{"$ref":"#/components/schemas/OrdersDataPlane.ApiLotSelectionMethod"},"packed_at":{"type":"string","description":"The timestamp when the shipment was packed.","format":"date-time","nullable":true},"picked_at":{"type":"string","description":"The timestamp when the items for the shipment were picked.","format":"date-time","nullable":true},"shipped_at":{"type":"string","description":"The timestamp when the order was shipped from its initial fulfillment center or sortation hub.","format":"date-time","nullable":true},"sla_at":{"type":"string","description":"The service level agreement timestamp for fulfillment. This is a time promised by ShipBob that a shipment will be picked, packed, and labelled.","format":"date-time","nullable":true},"sla_breach_status":{"$ref":"#/components/schemas/OrdersDataPlane.SLABreachStatus"},"sorted_at":{"type":"string","description":"The timestamp when the package was sorted into a gaylord (bulk box).","format":"date-time","nullable":true},"status":{"$ref":"#/components/schemas/OrdersDataPlane.FulfillmentStatus"}}},"OrdersDataPlane.ApiLocation":{"type":"object","description":"Represents a fulfillment center location.","additionalProperties":false,"properties":{"id":{"type":"integer","description":"The unique identifier for the fulfillment center.","format":"int32","example":42},"name":{"type":"string","description":"The name of the fulfillment center.","example":"Philadelphia (PA)","nullable":true}}},"OrdersDataPlane.ApiLotInfo":{"type":"object","description":"Represents lot information for a specific inventory item, including the selection method, lot date, and lot number. A lot is a specific batch of some product that is produced or received together, often sharing a common characteristic such as a production date or quality control status.","additionalProperties":false,"properties":{"lot_date":{"type":"string","description":"A date used to mark the lot. This date could represent the lot's expiration, manufacture, or some other significant date.","format":"date-time","nullable":true},"lot_number":{"type":"string","description":"The unique identifier assigned to the lot, which is not necessarily a number.","example":"ZYX-12345","nullable":true},"selection_method":{"$ref":"#/components/schemas/OrdersDataPlane.ApiLotSelectionMethod"}}},"OrdersDataPlane.ApiLotSelectionMethod":{"type":"string","description":"Represents the method of lot selection for an order. The default, ShipbobChooses, means ShipBob will select from the earliest lot date first. Specific, only allowed on B2B orders, lets the merchant select inventory from any lot available.","enum":["ShipbobChooses","Specific"]},"OrdersDataPlane.ApiMeasurementInfo":{"type":"object","description":"Represents the measurement information for a packaged shipment, including weight, length, width, and height.","additionalProperties":false,"properties":{"height":{"$ref":"#/components/schemas/OrdersDataPlane.ApiUnitOfMeasure"},"length":{"$ref":"#/components/schemas/OrdersDataPlane.ApiUnitOfMeasure"},"weight":{"$ref":"#/components/schemas/OrdersDataPlane.ApiUnitOfMeasure"},"width":{"$ref":"#/components/schemas/OrdersDataPlane.ApiUnitOfMeasure"}}},"OrdersDataPlane.ApiOnHoldInfo":{"type":"object","description":"Represents information about an order that is on hold.","additionalProperties":false,"properties":{"inventory_ids":{"type":"array","description":"A list of IDs representing inventory that are causing this hold, if applicable.","example":[123,456],"items":{"type":"integer","format":"int32"},"nullable":true},"reason":{"type":"string","description":"The reason why the order is on hold.","example":"International Hazmat","nullable":true}}},"OrdersDataPlane.ApiOrderSource":{"type":"object","description":"Represents the source of an order, including details about the ingestion channel, reference identifiers, and order metadata. This is used to track where the order originated from and how it was brought into the system.","additionalProperties":false,"properties":{"ingestion_channel_id":{"type":"integer","description":"The unique identifier for the ingestion channel associated with the order source. The ingestion channel is the last store the order passed through before being ingested into the system.","format":"int32","example":12345},"ingestion_channel_name":{"type":"string","description":"The name of the channel associated with the last store the order passed through before being brought into the system.","example":"myspecialshopifystore","nullable":true},"ingestion_channel_type":{"type":"string","description":"The type of the ingestion channel associated with the order source. This helps in identifying the platform or service through which the order was ingested.","example":"Shopify","nullable":true},"purchased_at":{"type":"string","description":"The timestamp when the order was purchased by an end customer, stored in UTC time.","format":"date-time","nullable":true},"reference_id":{"type":"string","description":"The reference identifier for the order source, which can be a unique identifier in the context of the ingestion channel type.","example":12345678901234567000,"nullable":true},"sales_channel_type":{"type":"string","description":"The type of the sales channel where the order was actually sold. The sales channel may be different from the ingestion channel if the order was processed on a middleware platform between the order's purchase and its ingestion into ShipBob.","example":"TikTok","nullable":true},"shipping_method":{"type":"string","description":"The shipping method selected for the order as defined in the merchant's store.","example":"Express Shipping","nullable":true},"store_order_id":{"type":"string","description":"The unique identifier for the order in the merchant's store. This is often an order ID from a merchant-specific store within a platform such as Shopify or Amazon.","example":"SO-123456","nullable":true},"store_tags":{"type":"string","description":"The tags associated with the order in the merchant's store. This can include various labels or identifiers that the merchant uses to categorize or prioritize orders.","example":"urgent, gift","nullable":true}}},"OrdersDataPlane.ApiOrderType":{"type":"string","description":"The type of the order. This is an enumeration which defines the various high-level type categories of orders.","enum":["Unknown","Deprecated","D2C","B2B","AmazonFBA","InternalTransfer","DropShip","Kitting"]},"OrdersDataPlane.ApiPackInfo":{"type":"object","description":"Information about the packaging of a shipment.","additionalProperties":false,"properties":{"measurements":{"$ref":"#/components/schemas/OrdersDataPlane.ApiMeasurementInfo"},"package_material_type":{"$ref":"#/components/schemas/OrdersDataPlane.PackageMaterialTypeEnum"}}},"OrdersDataPlane.ApiPageFilter":{"type":"object","description":"Filter for pagination.","additionalProperties":false,"properties":{"page_number":{"type":"integer","description":"The page number to retrieve.","format":"int32","example":1,"nullable":true},"page_size":{"type":"integer","description":"The number of items per page.","format":"int32","example":25},"page_token":{"type":"string","description":"Token for the next or previous page.","example":"aBC123DeF","nullable":true}}},"OrdersDataPlane.ApiProductVariant":{"type":"object","description":"Represents a product variant, which is a specific version of a product.","additionalProperties":false,"properties":{"id":{"type":"integer","description":"The unique identifier for the product variant.","format":"int32","example":123456},"name":{"type":"string","description":"The name of the product variant. This is a not-necessarily-unique identifier used to distinguish inventory.","example":"My Product","nullable":true},"sku":{"type":"string","description":"The stock keeping unit (SKU) of the product variant. This is a not-necessarily-unique identifier used to distinguish inventory.","example":"Product-123","nullable":true}}},"OrdersDataPlane.ApiRecipient":{"type":"object","description":"Represents the recipient of a package, including their name, address, and contact information.","additionalProperties":false,"properties":{"address_line1":{"type":"string","description":"The first line of the recipient's address.","example":"123 Main St","nullable":true},"address_line2":{"type":"string","description":"The second line of the recipient's address, such as an apartment or suite number.","example":"Apt 4B","nullable":true},"city":{"type":"string","description":"The city where the recipient is located.","example":"Chicago","nullable":true},"company":{"type":"string","description":"The company or organization the recipient is associated with, if applicable.","example":"ShipBob","nullable":true},"country":{"type":"string","description":"The country of the recipient's address.","example":"US","nullable":true},"email":{"type":"string","description":"The recipient's email address.","example":"john.doe@example.com","nullable":true},"full_name":{"type":"string","description":"The full name of the recipient.","example":"John Doe","nullable":true},"is_valid":{"type":"boolean","description":"Indicates whether the recipient's address has been validated. A null value indicates that the validation has not been attempted.","nullable":true},"latitude":{"type":"number","description":"The latitude of the recipient's address in decimal degrees. A null value indicates that geocoding has not been attempted or did not produce a result.","format":"double","example":41.8781136,"nullable":true},"longitude":{"type":"number","description":"The longitude of the recipient's address in decimal degrees. A null value indicates that geocoding has not been attempted or did not produce a result.","format":"double","example":-87.6297982,"nullable":true},"phone_number":{"type":"string","description":"The recipient's phone number.","example":"555-123-4567","nullable":true},"postal_code":{"type":"string","description":"The postal code for the recipient's address.","example":60607,"nullable":true},"state_or_province":{"type":"string","description":"The state or province of the recipient's address.","example":"IL","nullable":true}}},"OrdersDataPlane.ApiSearchRequest":{"type":"object","description":"A request to search for data with optional filtering, sorting, and pagination.","example":{"page_filter":{"page_number":1,"page_size":25,"page_token":"aBC123DeF"},"search_filter":{"conditions":[{"field":"order_id","type":"eq","value":123},{"field":"order_id","type":"eq","value":456}],"type":"any"},"sort_filters":[{"ascending":true,"field":"imported_at"}]},"additionalProperties":false,"properties":{"page_filter":{"$ref":"#/components/schemas/OrdersDataPlane.ApiPageFilter"},"search_filter":{"$ref":"#/components/schemas/OrdersDataPlane.SearchFilter"},"sort_filters":{"type":"array","items":{"$ref":"#/components/schemas/OrdersDataPlane.ApiSortFilter"},"nullable":true}}},"OrdersDataPlane.ApiShipment":{"type":"object","description":"Represents a shipment in the system, including its fulfillment details, status, shipping instructions, tracking information, associated shipping lines, and package info.","additionalProperties":false,"properties":{"created_at":{"type":"string","description":"The timestamp when the shipment was ingested into our system. This is stored in UTC","format":"date-time"},"fulfillment":{"$ref":"#/components/schemas/OrdersDataPlane.ApiFulfillmentInfo"},"legacy_last_updated_at":{"type":"string","description":"The timestamp when our system last pushed out a tracking update for this shipment. This is stored in UTC. This timestamp is most frequently set when a shipment is labelled, but it may not represent the labelled timestamp.","format":"date-time","nullable":true},"lines":{"type":"array","items":{"$ref":"#/components/schemas/OrdersDataPlane.ApiShipmentLine"},"nullable":true},"packs":{"type":"array","items":{"$ref":"#/components/schemas/OrdersDataPlane.ApiPackInfo"},"nullable":true},"shipment_id":{"type":"integer","description":"The unique identifier for the shipment.","format":"int64","example":123456789},"shipping_instructions":{"$ref":"#/components/schemas/OrdersDataPlane.ApiShippingInfo"},"status":{"$ref":"#/components/schemas/OrdersDataPlane.ApiStatusInfo"},"store_order_id":{"type":"string","description":"The unique identifier for the order in the merchant's store. This is often an order ID from a merchant-specific store within a platform such as Shopify or Amazon.","example":"SO-123456","nullable":true},"tracking":{"$ref":"#/components/schemas/OrdersDataPlane.ApiTrackingInfo"}}},"OrdersDataPlane.ApiShipmentLine":{"type":"object","description":"Represents a single line item in a shipment, detailing the product and its quantity.","additionalProperties":false,"properties":{"committed_quantity":{"type":"integer","description":"The quantity of the inventory item that has been allocated to the shipment.","format":"int32","example":5},"inventory_id":{"type":"integer","description":"A unique identifier for the inventory item.","format":"int32","example":1234567},"is_hazmat":{"type":"boolean","description":"Indicates whether the inventory item is hazardous material.","nullable":true},"is_lot":{"type":"boolean","description":"Indicates whether the inventory item belongs to a lot, a grouping of the same inventory with some significance.","nullable":true},"lot":{"$ref":"#/components/schemas/OrdersDataPlane.ApiLotInfo"},"product_variant":{"$ref":"#/components/schemas/OrdersDataPlane.ApiProductVariant"},"quantity":{"type":"integer","description":"The quantity of the inventory item requested by the shipment.","format":"int32","example":5},"serial_numbers":{"type":"array","description":"A list of serial numbers for the inventory item, if applicable.","example":["123a","124b","125c","126d","127e"],"items":{"type":"string"},"nullable":true}}},"OrdersDataPlane.ApiShipmentStatusCode":{"type":"string","description":"Represents the status of a shipment between ingestion and delivery. Additional statuses exist to mark state of warehouse operations (e.g. picking, packing) and delivery milestones.","enum":["Unknown","ImportReview","OnHold","Exception","InFulfillment","Cancelled","Cleanswept","Shipped","Completed"]},"OrdersDataPlane.ApiShipmentView":{"type":"object","description":"Represents a view of a shipment. This is used for API responses to provide detailed shipment information while allowing redaction of some financial information.","additionalProperties":false,"properties":{"legacy_order_type_id":{"type":"integer","description":"The identifier for the legacy order type.","format":"int32","example":8},"merchant_id":{"type":"integer","description":"The unique identifier for the merchant associated with the order.","format":"int32","example":12345},"order_id":{"type":"integer","description":"The unique identifier for the order.","format":"int64","example":1234567890},"order_type":{"$ref":"#/components/schemas/OrdersDataPlane.ApiOrderType"},"shipment":{"$ref":"#/components/schemas/OrdersDataPlane.ApiShipment"},"source":{"$ref":"#/components/schemas/OrdersDataPlane.ApiOrderSource"}}},"OrdersDataPlane.ApiShipmentViewApiPage":{"type":"object","description":"A paginated list of results.","additionalProperties":false,"properties":{"next_page_token":{"type":"string","description":"A token to retrieve the next page of results.","example":"+aBC123DeF","nullable":true},"prev_page_token":{"type":"string","description":"A token to retrieve the previous page of results.","example":"-aBC123DeF","nullable":true},"results":{"type":"array","description":"The results on the current page.","items":{"$ref":"#/components/schemas/OrdersDataPlane.ApiShipmentView"},"nullable":true},"total_count":{"type":"integer","description":"The total number of results.","format":"int64","example":100,"nullable":true}}},"OrdersDataPlane.ApiShippingInfo":{"type":"object","description":"Contains all information related to the shipping of an order, such as address and contact info for a recipient, chosen shipping service, and insurance information.","additionalProperties":false,"properties":{"gift_message":{"type":"string","description":"An optional message intended for the recipient.","example":"Happy Birthday!","nullable":true},"insured_value":{"$ref":"#/components/schemas/OrdersDataPlane.ApiCurrency"},"require_signature":{"type":"boolean","description":"Indicates whether a signature is required upon delivery."},"ship_option":{"type":"string","description":"The shipping option selected for the order. This may or may not be specific to a carrier. This indicates the service that the merchant will be billed for.","example":"Ground","nullable":true},"ship_to":{"$ref":"#/components/schemas/OrdersDataPlane.ApiRecipient"},"upgraded_ship_option":{"type":"string","description":"The shipping option which the shipment will be shipped at, if different from the billed ShipOption. If this value is set, ShipBob has provided an upgraded shipping speed at no cost to the merchant.","example":"Overnight","nullable":true}}},"OrdersDataPlane.ApiSortFilter":{"type":"object","additionalProperties":false,"properties":{"ascending":{"type":"boolean","description":"True sorts by ascending order, false sorts by descending order."},"field":{"type":"string","description":"The name of the field to sort by. This should match a value in the SearchField enum. By convention this is given in camel_case, but it will be converted to PascalCase when parsed.","example":"imported_at","nullable":true}}},"OrdersDataPlane.ApiStatusInfo":{"type":"object","description":"Represents the status of an order, including its current state and info on any holds or exceptions. All timestamps are in UTC.","additionalProperties":false,"properties":{"exception_at":{"type":"string","description":"The timestamp when an an order was placed in exception status due to lack of available inventory in a location.","format":"date-time","nullable":true},"exceptions":{"type":"array","items":{"$ref":"#/components/schemas/OrdersDataPlane.ApiExceptionInfo"},"nullable":true},"holds":{"type":"array","items":{"$ref":"#/components/schemas/OrdersDataPlane.ApiOnHoldInfo"},"nullable":true},"name":{"$ref":"#/components/schemas/OrdersDataPlane.ApiShipmentStatusCode"},"on_hold_at":{"type":"string","description":"The timestamp when the order was placed on hold by ShipBob.","format":"date-time","nullable":true}}},"OrdersDataPlane.ApiTrackingInfo":{"type":"object","description":"Represents the tracking information for a shipment, including carrier details, tracking number, and status updates. Since timestamps are provided by the carrier, their timezone is not guaranteed.","additionalProperties":false,"properties":{"carrier":{"type":"string","description":"The shipping carrier for the package.","example":"FedEx","nullable":true},"carrier_service":{"type":"string","description":"The service offered by the carrier.","example":"Ground","nullable":true},"delivered_at":{"type":"string","description":"The timestamp when the package was successfully delivered.","format":"date-time","nullable":true},"delivery_attempt_failed_at":{"type":"string","description":"The timestamp of a failed delivery attempt.","format":"date-time","nullable":true},"delivery_exception_at":{"type":"string","description":"The timestamp of a delivery exception, such as a delay or damage.","format":"date-time","nullable":true},"first_scanned_at":{"type":"string","description":"The timestamp of the first carrier scan, indicating the package is in their possession.","format":"date-time","nullable":true},"in_transit_at":{"type":"string","description":"The timestamp when the package was marked as in transit.","format":"date-time","nullable":true},"out_for_delivery_at":{"type":"string","description":"The timestamp when the package was marked as out for delivery.","format":"date-time","nullable":true},"status":{"$ref":"#/components/schemas/OrdersDataPlane.TrackingStatus"},"tracking_number":{"type":"string","description":"The tracking number assigned by the carrier.","example":"1Z9999W99999999999","nullable":true},"tracking_updated_at":{"type":"string","description":"The timestamp when the tracking information was last updated by the carrier.","format":"date-time","nullable":true},"tracking_uploaded_at":{"type":"string","description":"The timestamp when the tracking information was uploaded to ShipBob's system.","format":"date-time","nullable":true},"url":{"type":"string","description":"The URL to the carrier's tracking page for this package.","example":"https://www.fedex.com/fedextrack/?trknbr=123456789012","nullable":true}}},"OrdersDataPlane.ApiUnitOfMeasure":{"type":"object","description":"Represents a unit of measure, consisting of a value and a unit type.","additionalProperties":false,"properties":{"unit":{"type":"string","description":"The unit of measurement.","example":"oz","nullable":true},"value":{"type":"number","description":"The numerical value of the measurement.","format":"double","example":12.34}}},"OrdersDataPlane.FulfillmentStatus":{"type":"string","description":"The status of a shipment within ShipBob. Covers both allocation and warehouse operations at a high level.","enum":["PendingAssignment","PartiallyAllocated","Allocated","PickStarted","Picked","Packed","Labelled","Sorted","Shipped"]},"OrdersDataPlane.PackageMaterialTypeEnum":{"type":"string","description":"Represents the type of container used to hold a shipment. Merchants assign a packaging preference to each fulfillable item, but the final choice in packaging ultimately lies with the packer. Packaging can be provided by ShipBob or by the merchant via custom packaging.","enum":["Unknown","Box","BubbleMailer","PolyMailer","FragileBox","PosterTube","CustomBox","Bookfold","ShipInOwnContainer","CustomBubbleMailer","CustomPolyMailer"]},"OrdersDataPlane.SLABreachStatus":{"type":"string","enum":["SLANotSet","WithinEstimate","EstimatedFulfillmentDateNotSet","Breached","FulfilledOnTime"]},"OrdersDataPlane.SearchFilter":{"type":"object","discriminator":{"propertyName":"type"},"oneOf":[{"type":"object","description":"Matches if any of the conditions are true","example":{"conditions":[{"field":"order_id","type":"eq","value":123},{"field":"order_id","type":"eq","value":456}],"type":"any"},"additionalProperties":false,"required":["type","conditions"],"properties":{"conditions":{"type":"array","description":"Array of SearchFilter conditions","items":{"description":"A SearchFilter condition (recursive reference to SearchFilter schema)","additionalProperties":false}},"type":{"type":"string","enum":["any"]}}},{"type":"object","description":"Matches if all of the conditions are true","example":{"conditions":[{"field":"merchant_id","type":"eq","value":100},{"field":"lot_date","type":"gt","value":"2024-01-01T00:00:00Z"}],"type":"all"},"additionalProperties":false,"required":["type","conditions"],"properties":{"conditions":{"type":"array","description":"Array of SearchFilter conditions","items":{"description":"A SearchFilter condition (recursive reference to SearchFilter schema)","additionalProperties":false}},"type":{"type":"string","enum":["all"]}}},{"type":"object","description":"Negates the condition","example":{"condition":{"field":"shipment_status","type":"eq","value":"Cancelled"},"type":"not"},"additionalProperties":false,"required":["type","condition"],"properties":{"condition":{"description":"A SearchFilter condition (recursive reference to SearchFilter schema)","additionalProperties":false},"type":{"type":"string","enum":["not"]}}},{"type":"object","description":"Field equals value","example":{"field":"order_id","type":"eq","value":12345},"additionalProperties":false,"required":["type","field","value"],"properties":{"field":{"type":"string","description":"The field to filter on"},"type":{"type":"string","enum":["eq"]},"value":{"description":"The value to compare against","additionalProperties":false}}},{"type":"object","description":"Field greater than value","example":{"field":"lot_date","type":"gt","value":"2024-01-01T00:00:00Z"},"additionalProperties":false,"required":["type","field","value"],"properties":{"field":{"type":"string","description":"The field to filter on"},"type":{"type":"string","enum":["gt"]},"value":{"description":"The value to compare against","additionalProperties":false}}},{"type":"object","description":"Field greater than or equal to value","example":{"field":"lot_date","type":"gte","value":"2024-01-01T00:00:00Z"},"additionalProperties":false,"required":["type","field","value"],"properties":{"field":{"type":"string","description":"The field to filter on"},"type":{"type":"string","enum":["gte"]},"value":{"description":"The value to compare against","additionalProperties":false}}},{"type":"object","description":"Field less than value","example":{"field":"lot_date","type":"lt","value":"2024-02-01T00:00:00Z"},"additionalProperties":false,"required":["type","field","value"],"properties":{"field":{"type":"string","description":"The field to filter on"},"type":{"type":"string","enum":["lt"]},"value":{"description":"The value to compare against","additionalProperties":false}}},{"type":"object","description":"Field less than or equal to value","example":{"field":"lot_date","type":"lte","value":"2024-02-01T00:00:00Z"},"additionalProperties":false,"required":["type","field","value"],"properties":{"field":{"type":"string","description":"The field to filter on"},"type":{"type":"string","enum":["lte"]},"value":{"description":"The value to compare against","additionalProperties":false}}},{"type":"object","description":"Field value is in the list of values","example":{"field":"shipment_status","type":"in","values":["OnHold","Processing","Shipped"]},"additionalProperties":false,"required":["type","field","values"],"properties":{"field":{"type":"string","description":"The field to filter on"},"type":{"type":"string","enum":["in"]},"values":{"type":"array","description":"Array of values to check for inclusion","items":{"description":"The values to match against","additionalProperties":false}}}},{"type":"object","description":"Text search","example":{"field":"recipient_name","type":"text","value":"John Doe"},"additionalProperties":false,"required":["type","value"],"properties":{"field":{"type":"string","description":"Optional field to search within. If omitted, searches across all text fields."},"type":{"type":"string","enum":["text"]},"value":{"type":"string","description":"The text to search for"}}}]},"OrdersDataPlane.TrackingStatus":{"type":"string","description":"Denotes type of tracking update provided by carrier as a shipment travels between the time it is labeled at a fulfillment center and it is delivered to the end customer.","enum":["AwaitingScan","Processing","InTransit","OutForDelivery","DeliveryAttemptFailed","DeliveryException","Delivered"]},"Products.AdditionalHazmatAttributesRequestModel":{"type":"object","additionalProperties":false,"properties":{"charge_state_percentage":{"type":"number","format":"double","nullable":true},"container_metal":{"type":"boolean","nullable":true},"lithium_battery_packaging":{"type":"string","nullable":true},"lithium_battery_type":{"type":"string","nullable":true},"magnet":{"type":"boolean","nullable":true},"net_volume":{"type":"number","format":"double","nullable":true},"net_weight":{"type":"number","format":"double","nullable":true}}},"Products.AdditionalHazmatAttributesViewModel":{"type":"object","additionalProperties":false,"properties":{"charge_state_percentage":{"type":"number","format":"double","nullable":true},"container_metal":{"type":"boolean","nullable":true},"lithium_battery_packaging":{"type":"string","nullable":true},"lithium_battery_type":{"type":"string","nullable":true},"magnet":{"type":"boolean","nullable":true},"net_volume":{"type":"number","format":"double","nullable":true},"net_weight":{"type":"number","format":"double","nullable":true}}},"Products.AmazonChannelMetadataRequestModel":{"type":"object","description":"Amazon Sales Channel Information with custom Amazon Fields","properties":{"asin":{"type":"string","nullable":true},"fnsku":{"type":"string","nullable":true},"fulfillment_channel":{"type":"string","nullable":true},"platform":{"type":"string","readOnly":true,"nullable":true}},"allOf":[{"$ref":"#/components/schemas/Products.ChannelMetadataRequestModel"}]},"Products.AmazonChannelMetadataViewModel":{"type":"object","properties":{"asin":{"type":"string","nullable":true},"fnsku":{"type":"string","nullable":true},"fulfillment_channel":{"type":"string","nullable":true}},"allOf":[{"$ref":"#/components/schemas/Products.ChannelMetadataViewModel"}]},"Products.AmazonProductChannelMetadataModel":{"type":"object","properties":{"asin":{"type":"string","nullable":true},"fnsku":{"type":"string","nullable":true},"fulfillment_channel":{"type":"string","nullable":true}},"allOf":[{"$ref":"#/components/schemas/Products.BaseProductChannelMetadataModel"}]},"Products.ApplicableCategoryViewModel":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"sub_category_ids":{"type":"array","items":{"type":"integer","format":"int32"},"nullable":true}}},"Products.AssociatedBundlesViewModel":{"type":"object","additionalProperties":false,"properties":{"product_id":{"type":"integer","format":"int64"},"product_name":{"type":"string","nullable":true},"quantity":{"type":"integer","format":"int32"},"variant_id":{"type":"integer","format":"int64"},"variant_sku":{"type":"string","nullable":true}}},"Products.BarcodeModel":{"type":"object","additionalProperties":false,"properties":{"sticker_url":{"type":"string","nullable":true},"value":{"type":"string","nullable":true}}},"Products.BarcodeRequestModel":{"type":"object","additionalProperties":false,"properties":{"sticker_url":{"type":"string","nullable":true},"value":{"type":"string","nullable":true}}},"Products.BarcodeViewModel":{"type":"object","additionalProperties":false,"properties":{"sticker_url":{"type":"string","nullable":true},"value":{"type":"string","nullable":true}}},"Products.BaseAdditionalHazmatAttributesModel":{"type":"object","additionalProperties":false,"properties":{"charge_state_percentage":{"type":"number","format":"double","nullable":true},"container_metal":{"type":"boolean","nullable":true},"lithium_battery_packaging":{"type":"string","nullable":true},"lithium_battery_type":{"type":"string","nullable":true},"magnet":{"type":"boolean","nullable":true},"net_volume":{"type":"number","format":"double","nullable":true},"net_weight":{"type":"number","format":"double","nullable":true}}},"Products.BaseBundleDefinitionModel":{"type":"object","additionalProperties":false,"properties":{"quantity":{"type":"integer","format":"int32"},"variant_id":{"type":"integer","format":"int64"}}},"Products.BaseChannelMetadataRequestModel":{"type":"object","description":"Standard Channel Metadata Record to store SellerSKU for a Sales Channel","allOf":[{"$ref":"#/components/schemas/Products.ChannelMetadataRequestModel"}]},"Products.BaseCustomsModel":{"type":"object","additionalProperties":false,"properties":{"country_code_of_origin":{"type":"string","nullable":true},"currency":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"hs_tariff_code":{"type":"string","nullable":true},"is321_eligible":{"type":"boolean"},"value":{"type":"integer","format":"int32","nullable":true}}},"Products.BaseDimensionModel":{"type":"object","additionalProperties":false,"properties":{"height":{"type":"number","format":"double"},"length":{"type":"number","format":"double"},"width":{"type":"number","format":"double"}}},"Products.BaseFulfillmentSettingsModel":{"type":"object","additionalProperties":false,"properties":{"dangerous_goods":{"type":"boolean"},"is_bpm_parcel":{"type":"boolean"},"is_case_pick":{"type":"boolean"},"msds_url":{"type":"string","nullable":true},"requires_prop65":{"type":"boolean"},"serial_scan":{"$ref":"#/components/schemas/Products.BaseSerialScanModel"}}},"Products.BaseLotInformationModel":{"type":"object","additionalProperties":false,"properties":{"is_lot":{"type":"boolean"},"minimum_shelf_life_days":{"type":"integer","format":"int32","nullable":true}}},"Products.BaseProductChannelMetadataModel":{"type":"object","allOf":[{"$ref":"#/components/schemas/Products.ProductChannelMetadataModel"}]},"Products.BaseProductRequestModel":{"type":"object","properties":{"name":{"type":"string","nullable":true},"taxonomy_id":{"type":"integer","format":"int32","nullable":true},"type_id":{"type":"integer","format":"int32"}}},"Products.BaseProductVariantModel":{"type":"object","properties":{"additional_hazmat_attributes":{"$ref":"#/components/schemas/Products.BaseAdditionalHazmatAttributesModel"},"bundle_definition":{"type":"array","items":{"$ref":"#/components/schemas/Products.BaseBundleDefinitionModel"},"nullable":true},"channel_metadata":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Products.AmazonProductChannelMetadataModel"},{"$ref":"#/components/schemas/Products.BaseProductChannelMetadataModel"},{"$ref":"#/components/schemas/Products.BigCommerceProductChannelMetadataModel"},{"$ref":"#/components/schemas/Products.ShopifyProductChannelMetadataModel"}]},"nullable":true},"customs":{"$ref":"#/components/schemas/Products.BaseCustomsModel"},"dimension":{"$ref":"#/components/schemas/Products.BaseDimensionModel"},"fulfillment_settings":{"$ref":"#/components/schemas/Products.BaseFulfillmentSettingsModel"},"gtin":{"type":"string","nullable":true},"is_digital":{"type":"boolean"},"lot_information":{"$ref":"#/components/schemas/Products.BaseLotInformationModel"},"name":{"type":"string","nullable":true},"packaging_material_type_id":{"type":"integer","format":"int32","nullable":true},"packaging_requirement_id":{"type":"integer","format":"int32","nullable":true},"return_preferences":{"$ref":"#/components/schemas/Products.BaseReturnPreferencesModel"},"reviews_pending":{"type":"array","items":{"$ref":"#/components/schemas/Products.ReviewsPendingType"},"nullable":true},"sku":{"type":"string","nullable":true},"status":{"$ref":"#/components/schemas/Products.VariantStatus"},"upc":{"type":"string","nullable":true},"weight":{"type":"number","format":"double"}}},"Products.BaseProductVariantRequestModel":{"type":"object","properties":{"additional_hazmat_attributes":{"$ref":"#/components/schemas/Products.AdditionalHazmatAttributesRequestModel"},"bundle_definition":{"type":"array","items":{"$ref":"#/components/schemas/Products.BundleDefinitionRequestModel"},"nullable":true},"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"}]},"nullable":true},"customs":{"$ref":"#/components/schemas/Products.CustomsRequestModel"},"dimension":{"$ref":"#/components/schemas/Products.DimensionRequestModel"},"fulfillment_settings":{"$ref":"#/components/schemas/Products.FulfillmentSettingsRequestModel"},"gtin":{"type":"string","nullable":true},"is_digital":{"type":"boolean"},"lot_information":{"$ref":"#/components/schemas/Products.LotInformationRequestModel"},"name":{"type":"string","nullable":true},"packaging_material_type_id":{"type":"integer","format":"int32","nullable":true},"packaging_requirement_id":{"type":"integer","format":"int32","nullable":true},"return_preferences":{"$ref":"#/components/schemas/Products.ReturnPreferencesRequestModel"},"sku":{"type":"string","nullable":true},"status_id":{"type":"integer","format":"int32"},"upc":{"type":"string","nullable":true},"weight":{"type":"number","format":"double"}}},"Products.BaseReturnPreferencesModel":{"type":"object","additionalProperties":false,"properties":{"backup_action_id":{"type":"integer","format":"int32","nullable":true},"instructions":{"type":"string","nullable":true},"primary_action_id":{"type":"integer","format":"int32"},"return_to_sender_backup_action_id":{"type":"integer","format":"int32","nullable":true},"return_to_sender_primary_action_id":{"type":"integer","format":"int32","nullable":true}}},"Products.BaseSerialScanModel":{"type":"object","additionalProperties":false,"properties":{"exact_character_length":{"type":"integer","format":"int32","nullable":true},"is_enabled":{"type":"boolean"},"prefix":{"type":"string","nullable":true},"suffix":{"type":"string","nullable":true}}},"Products.BaseTaxonomyViewModel":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"path":{"type":"string","nullable":true}}},"Products.BigCommerceChannelMetadataRequestModel":{"type":"object","description":"BigCommerce Sales Channel Information with custom Amazon Fields","properties":{"platform":{"type":"string","readOnly":true,"nullable":true},"platform_product_id":{"type":"integer","format":"int64","nullable":true},"platform_variant_id":{"type":"integer","format":"int64","nullable":true}},"allOf":[{"$ref":"#/components/schemas/Products.ChannelMetadataRequestModel"}]},"Products.BigCommerceChannelMetadataViewModel":{"type":"object","properties":{"platform_product_id":{"type":"integer","format":"int64","nullable":true},"platform_variant_id":{"type":"integer","format":"int64","nullable":true}},"allOf":[{"$ref":"#/components/schemas/Products.ChannelMetadataViewModel"}]},"Products.BigCommerceProductChannelMetadataModel":{"type":"object","properties":{"platform_product_id":{"type":"integer","format":"int64","nullable":true},"platform_variant_id":{"type":"integer","format":"int64","nullable":true}},"allOf":[{"$ref":"#/components/schemas/Products.BaseProductChannelMetadataModel"}]},"Products.BundleDefinitionRequestModel":{"type":"object","additionalProperties":false,"properties":{"quantity":{"type":"integer","format":"int32"},"variant_id":{"type":"integer","format":"int64"}}},"Products.BundleDefinitionViewModel":{"type":"object","additionalProperties":false,"properties":{"product_id":{"type":"integer","format":"int64"},"quantity":{"type":"integer","format":"int32"},"variant_id":{"type":"integer","format":"int64"},"variant_name":{"type":"string","nullable":true},"variant_sku":{"type":"string","nullable":true}}},"Products.ChannelMetadataRequestModel":{"type":"object","properties":{"channel_id":{"type":"integer","format":"int32","nullable":true},"currency":{"type":"string","nullable":true},"id":{"type":"integer","format":"int64","nullable":true},"is_inventory_sync_enabled":{"type":"boolean"},"legacy_product_id":{"type":"integer","format":"int64","nullable":true},"platform":{"type":"string","nullable":true},"platform_identifier":{"type":"string","nullable":true},"platform_inventory_item_id":{"type":"string","nullable":true},"price":{"type":"number","format":"double"},"seller_sku":{"type":"string","nullable":true}}},"Products.ChannelMetadataViewModel":{"type":"object","properties":{"channel_id":{"type":"integer","format":"int64"},"channel_name":{"type":"string","nullable":true},"currency":{"type":"string","nullable":true},"id":{"type":"integer","format":"int64"},"is_inventory_sync_enabled":{"type":"boolean"},"legacy_product_id":{"type":"integer","format":"int64","nullable":true},"platform":{"type":"string","nullable":true},"platform_identifier":{"type":"string","nullable":true},"platform_inventory_item_id":{"type":"string","nullable":true},"price":{"type":"number","format":"double"},"seller_sku":{"type":"string","nullable":true}}},"Products.ChildTaxonomyViewModel":{"type":"object","properties":{"has_children":{"type":"boolean"}},"allOf":[{"$ref":"#/components/schemas/Products.BaseTaxonomyViewModel"}]},"Products.ConvertVariantToBundleRequest":{"type":"object","example":{"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"}],"name":"string","sku":"string"},"additionalProperties":false,"properties":{"bundle_definition":{"type":"array","items":{"$ref":"#/components/schemas/Products.BundleDefinitionRequestModel"},"nullable":true},"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"}]},"nullable":true},"name":{"type":"string","nullable":true},"sku":{"type":"string","nullable":true}}},"Products.CreateProductRequestModelV3":{"type":"object","properties":{"variants":{"type":"array","items":{"$ref":"#/components/schemas/Products.CreateProductVariantRequestModelV3"},"nullable":true}},"allOf":[{"$ref":"#/components/schemas/Products.BaseProductRequestModel"}]},"Products.CreateProductRequestModelV5":{"type":"object","example":{"name":"string","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},"barcodes":[{"sticker_url":"string","value":"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}]},"properties":{"variants":{"type":"array","items":{"$ref":"#/components/schemas/Products.CreateProductVariantRequestModelV5"},"nullable":true}},"allOf":[{"$ref":"#/components/schemas/Products.BaseProductRequestModel"}]},"Products.CreateProductVariantRequestModel":{"type":"object","allOf":[{"$ref":"#/components/schemas/Products.BaseProductVariantRequestModel"}]},"Products.CreateProductVariantRequestModelV3":{"type":"object","properties":{"barcode_sticker_url":{"type":"string","nullable":true}},"allOf":[{"$ref":"#/components/schemas/Products.CreateProductVariantRequestModel"}]},"Products.CreateProductVariantRequestModelV3Array":{"type":"array","items":{"$ref":"#/components/schemas/Products.CreateProductVariantRequestModelV3"}},"Products.CreateProductVariantRequestModelV5":{"type":"object","properties":{"barcodes":{"type":"array","items":{"$ref":"#/components/schemas/Products.BarcodeRequestModel"},"nullable":true}},"allOf":[{"$ref":"#/components/schemas/Products.BaseProductVariantRequestModel"}]},"Products.CreateProductVariantRequestModelV5Array":{"type":"array","example":[{"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},"barcodes":[{"sticker_url":"string","value":"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}],"items":{"$ref":"#/components/schemas/Products.CreateProductVariantRequestModelV5"}},"Products.CustomsRequestModel":{"type":"object","additionalProperties":false,"properties":{"country_code_of_origin":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"hs_tariff_code":{"type":"string","nullable":true},"is321_eligible":{"type":"boolean"},"value":{"type":"integer","format":"int32","nullable":true}}},"Products.CustomsViewModel":{"type":"object","additionalProperties":false,"properties":{"country_code_of_origin":{"type":"string","nullable":true},"currency":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"hs_tariff_code":{"type":"string","nullable":true},"is321_eligible":{"type":"boolean"},"value":{"type":"integer","format":"int32","nullable":true}}},"Products.Delete.Api.V2.Variant.VariantId.Channel.Metadata.ChannelMetadataId.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Products.Delete.Api.V2.Variant.VariantId.Channel.Metadata.ChannelMetadataId.ChannelMetadataId.Integer":{"type":"integer","format":"int64"},"Products.Delete.Api.V2.Variant.VariantId.Channel.Metadata.ChannelMetadataId.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Delete.Api.V2.Variant.VariantId.Channel.Metadata.ChannelMetadataId.VariantId.Integer":{"type":"integer","format":"int64"},"Products.Delete.Api.V4.Product.ProductId.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Products.Delete.Api.V4.Product.ProductId.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Delete.Api.V4.Product.ProductId.ProductId.Integer":{"type":"integer","format":"int64"},"Products.Delete.Api.V5.Product.ProductId.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Products.Delete.Api.V5.Product.ProductId.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Delete.Api.V5.Product.ProductId.ProductId.Integer":{"type":"integer","format":"int64"},"Products.Delete.Api.V5.Variant.VariantId.Channel.Metadata.ChannelMetadataId.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Products.Delete.Api.V5.Variant.VariantId.Channel.Metadata.ChannelMetadataId.ChannelMetadataId.Integer":{"type":"integer","format":"int64"},"Products.Delete.Api.V5.Variant.VariantId.Channel.Metadata.ChannelMetadataId.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Delete.Api.V5.Variant.VariantId.Channel.Metadata.ChannelMetadataId.VariantId.Integer":{"type":"integer","format":"int64"},"Products.DimensionRequestModel":{"type":"object","additionalProperties":false,"properties":{"height":{"type":"number","format":"double"},"length":{"type":"number","format":"double"},"width":{"type":"number","format":"double"}}},"Products.DimensionViewModel":{"type":"object","additionalProperties":false,"properties":{"height":{"type":"number","format":"double"},"is_locked":{"type":"boolean"},"length":{"type":"number","format":"double"},"source":{"type":"string","nullable":true},"unit":{"type":"string","nullable":true},"width":{"type":"number","format":"double"}}},"Products.EnumViewModel":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string","nullable":true}}},"Products.FulfillmentSettingsRequestModel":{"type":"object","additionalProperties":false,"properties":{"dangerous_goods":{"type":"boolean"},"is_bpm_parcel":{"type":"boolean"},"is_case_pick":{"type":"boolean"},"msds_url":{"type":"string","nullable":true},"requires_prop65":{"type":"boolean"},"serial_scan":{"$ref":"#/components/schemas/Products.SerialScanRequestModel"}}},"Products.FulfillmentSettingsViewModel":{"type":"object","additionalProperties":false,"properties":{"dangerous_goods":{"type":"boolean"},"is_bpm_parcel":{"type":"boolean"},"is_case_pick":{"type":"boolean"},"msds_url":{"type":"string","nullable":true},"requires_prop65":{"type":"boolean"},"serial_scan":{"$ref":"#/components/schemas/Products.SerialScanViewModel"}}},"Products.Get.Api.Product.LastUpdatedTimestamp.DateTime":{"type":"string","description":"Looks for Products that have been updated since the given date"},"Products.Get.Api.V4.Product.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Products.Get.Api.V4.Product.Barcode.Int":{"description":"Barcode Associated with variant","additionalProperties":false},"Products.Get.Api.V4.Product.CategoryIds.List.Int":{"description":"List of Category Ids associated with product","additionalProperties":false},"Products.Get.Api.V4.Product.ChannelIds.List.Int":{"description":"Looks for Products variants by their channel IDs","additionalProperties":false},"Products.Get.Api.V4.Product.HasDigitalVariants.Boolean":{"description":"Looks for Products with/without digital variants","additionalProperties":false},"Products.Get.Api.V4.Product.HasVariants.Boolean":{"description":"Looks for Products with/without variants","additionalProperties":false},"Products.Get.Api.V4.Product.InventoryId.List.Int":{"description":"Looks for variants by its associated inventory id","additionalProperties":false},"Products.Get.Api.V4.Product.LegacyIds.List.Int":{"description":"Looks for Products with by Legacy Product Id(s)","additionalProperties":false},"Products.Get.Api.V4.Product.Name.String":{"description":"Looks for Products/Variants by name","additionalProperties":false},"Products.Get.Api.V4.Product.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Get.Api.V4.Product.OnHand.Integer":{"description":"Looks for Products with inventory","additionalProperties":false},"Products.Get.Api.V4.Product.PageSize.Int":{"additionalProperties":false},"Products.Get.Api.V4.Product.PlatformIds.List.String":{"description":"Looks for Products variants by their external Platform IDs","additionalProperties":false},"Products.Get.Api.V4.Product.ProductId.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Products.Get.Api.V4.Product.ProductId.List.Int":{"description":"Looks for Products with an assigned Id","additionalProperties":false},"Products.Get.Api.V4.Product.ProductId.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Get.Api.V4.Product.ProductId.ProductId.Integer":{"type":"integer","format":"int64"},"Products.Get.Api.V4.Product.ProductType.Integer":{"description":"Looks for Products by type","additionalProperties":false},"Products.Get.Api.V4.Product.ReviewsPending.List.ReviewsPendingType":{"description":"Looks for Products by ReviewsPending","additionalProperties":false},"Products.Get.Api.V4.Product.SKU.String":{"description":"Looks for Products that match the provided Sku query","additionalProperties":false},"Products.Get.Api.V4.Product.SalesChannel.List.String":{"description":"Looks for Products variants assigned to a platform/sales channel ","additionalProperties":false},"Products.Get.Api.V4.Product.Search.String":{"type":"string"},"Products.Get.Api.V4.Product.SellerSKU.String":{"description":"Looks for Products that match the provided Seller query","additionalProperties":false},"Products.Get.Api.V4.Product.SortBy.String":{"type":"string"},"Products.Get.Api.V4.Product.SortOrder.String":{"type":"string"},"Products.Get.Api.V4.Product.TaxonomyIds.List.Int":{"description":"Looks for Products variants by their taxonomy id or any descendants of the taxonomies sent separated by comma","additionalProperties":false},"Products.Get.Api.V4.Product.VariantId.List.Int":{"description":"Looks for products that contain a variant with the given ID","additionalProperties":false},"Products.Get.Api.V4.Product.VariantStatus.String":{"description":"Looks for Products with variants that contain provided status","additionalProperties":false},"Products.Get.Api.V4.Taxonomy.Forbidden.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Get.Api.V4.Taxonomy.Id.Forbidden.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Get.Api.V4.Taxonomy.Id.Id.Integer":{"type":"integer","format":"int32"},"Products.Get.Api.V4.Taxonomy.Id.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Get.Api.V4.Taxonomy.Id.Parent.Forbidden.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Get.Api.V4.Taxonomy.Id.Parent.Id.Integer":{"type":"integer","format":"int32"},"Products.Get.Api.V4.Taxonomy.Id.Parent.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Get.Api.V4.Taxonomy.Id.Parent.Unauthorized.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Get.Api.V4.Taxonomy.Id.Unauthorized.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Get.Api.V4.Taxonomy.Search.String":{"type":"string"},"Products.Get.Api.V4.Taxonomy.Unauthorized.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Get.Api.V5.Product.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Products.Get.Api.V5.Product.Barcode.Int":{"type":"integer","description":"Barcode Associated with variant"},"Products.Get.Api.V5.Product.Barcode.String":{"type":"string","description":"Barcode Associated with variant"},"Products.Get.Api.V5.Product.CategoryIds.List.Int":{"type":"array","description":"List of Category Ids associated with product","items":{"type":"integer"}},"Products.Get.Api.V5.Product.ChannelIds.List.Int":{"type":"array","description":"Looks for Products variants by their channel IDs","items":{"type":"integer"}},"Products.Get.Api.V5.Product.HasDigitalVariants.Boolean":{"type":"boolean","description":"Looks for Products with/without digital variants"},"Products.Get.Api.V5.Product.HasVariants.Boolean":{"type":"boolean","description":"Looks for Products with/without variants"},"Products.Get.Api.V5.Product.InventoryId.List.Int":{"type":"array","description":"Looks for variants by its associated inventory id","items":{"type":"integer"}},"Products.Get.Api.V5.Product.LegacyIds.List.Int":{"type":"array","description":"Looks for Products with by Legacy Product Id(s)","items":{"type":"integer"}},"Products.Get.Api.V5.Product.Name.String":{"type":"string","description":"Looks for Products/Variants by name"},"Products.Get.Api.V5.Product.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Get.Api.V5.Product.OnHand.Integer":{"type":"integer","description":"Looks for Products with inventory"},"Products.Get.Api.V5.Product.PageSize.Int":{"type":"integer"},"Products.Get.Api.V5.Product.PlatformIds.List.String":{"type":"array","description":"Looks for Products variants by their external Platform IDs","items":{"type":"string"}},"Products.Get.Api.V5.Product.ProductId.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Products.Get.Api.V5.Product.ProductId.List.Int":{"type":"array","description":"Looks for Products with an assigned Id","items":{"type":"integer"}},"Products.Get.Api.V5.Product.ProductId.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Get.Api.V5.Product.ProductId.ProductId.Integer":{"type":"integer","format":"int64"},"Products.Get.Api.V5.Product.ProductId.Variants.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Products.Get.Api.V5.Product.ProductId.Variants.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Get.Api.V5.Product.ProductId.Variants.ProductId.Integer":{"type":"integer","format":"int64"},"Products.Get.Api.V5.Product.ProductType.Integer":{"type":"integer","description":"Looks for Products by type"},"Products.Get.Api.V5.Product.ReviewsPending.List.ReviewsPendingType":{"type":"array","description":"Looks for Products by ReviewsPending","items":{"$ref":"#/components/schemas/Products.ReviewsPendingType"}},"Products.Get.Api.V5.Product.SKU.String":{"type":"string","description":"Looks for Products that match the provided Sku query"},"Products.Get.Api.V5.Product.SalesChannel.List.String":{"type":"array","description":"Looks for Products variants assigned to a platform/sales channel ","items":{"type":"string"}},"Products.Get.Api.V5.Product.Search.String":{"type":"string","description":"Search Products by name, sku, inventory id or product Id"},"Products.Get.Api.V5.Product.SellerSKU.String":{"type":"string","description":"Looks for Products that match the provided Seller query"},"Products.Get.Api.V5.Product.SortBy.String":{"type":"string"},"Products.Get.Api.V5.Product.SortOrder.String":{"type":"string"},"Products.Get.Api.V5.Product.TaxonomyIds.List.Int":{"type":"array","description":"Looks for Products variants by their taxonomy id or any descendants of the taxonomies sent separated by comma","items":{"type":"integer"}},"Products.Get.Api.V5.Product.VariantId.List.Int":{"type":"array","description":"Looks for products that contain a variant with the given ID","items":{"type":"integer"}},"Products.Get.Api.V5.Product.VariantStatus.String":{"type":"string","description":"Looks for Products with variants that contain provided status"},"Products.Get.Api.V5.Taxonomy.Forbidden.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Get.Api.V5.Taxonomy.Id.Forbidden.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Get.Api.V5.Taxonomy.Id.Id.Integer":{"type":"integer","format":"int32"},"Products.Get.Api.V5.Taxonomy.Id.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Get.Api.V5.Taxonomy.Id.Parent.Forbidden.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Get.Api.V5.Taxonomy.Id.Parent.Id.Integer":{"type":"integer","format":"int32"},"Products.Get.Api.V5.Taxonomy.Id.Parent.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Get.Api.V5.Taxonomy.Id.Parent.Unauthorized.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Get.Api.V5.Taxonomy.Id.Unauthorized.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Get.Api.V5.Taxonomy.Search.String":{"type":"string"},"Products.Get.Api.V5.Taxonomy.Unauthorized.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.HttpValidationProblemDetails":{"type":"object","additionalProperties":{"additionalProperties":false},"properties":{"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"nullable":true}},"allOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"}]},"Products.InventoryViewModel":{"type":"object","additionalProperties":false,"properties":{"inventory_id":{"type":"integer","format":"int32","nullable":true},"on_hand_qty":{"type":"integer","format":"int32"}}},"Products.LotInformationRequestModel":{"type":"object","additionalProperties":false,"properties":{"is_lot":{"type":"boolean"},"minimum_shelf_life_days":{"type":"integer","format":"int32","nullable":true}}},"Products.LotInformationViewModel":{"type":"object","additionalProperties":false,"properties":{"is_lot":{"type":"boolean"},"minimum_shelf_life_days":{"type":"integer","format":"int32","nullable":true}}},"Products.MergeVariantRequestModel":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int64"}}},"Products.MergeVariantRequestModelArray":{"type":"array","example":[{"id":0}],"items":{"$ref":"#/components/schemas/Products.MergeVariantRequestModel"}},"Products.MergedChildrenViewModel":{"type":"object","additionalProperties":false,"properties":{"channel_ids":{"type":"array","items":{"type":"integer","format":"int64"},"nullable":true},"completed_at":{"type":"string","format":"date-time"},"inventory_id":{"type":"integer","format":"int64","nullable":true},"variant_id":{"type":"integer","format":"int64"},"variant_name":{"type":"string","nullable":true}}},"Products.MigrateVariantRequestModel":{"type":"object","example":{"category_id":0,"name":"string","product_id":0,"sub_category_id":0,"taxonomy_id":0,"variants":[{"id":0,"name":"string"}]},"additionalProperties":false,"properties":{"category_id":{"type":"integer","format":"int32","nullable":true},"name":{"type":"string","nullable":true},"product_id":{"type":"integer","format":"int64"},"sub_category_id":{"type":"integer","format":"int32","nullable":true},"taxonomy_id":{"type":"integer","format":"int32","nullable":true},"variants":{"type":"array","items":{"$ref":"#/components/schemas/Products.VariantToMigrate"},"nullable":true}}},"Products.PackagingMaterialTypeViewModel":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true}}},"Products.PackagingRequirementViewModel":{"type":"object","additionalProperties":false,"properties":{"applicable_categories":{"type":"array","items":{"$ref":"#/components/schemas/Products.ApplicableCategoryViewModel"},"nullable":true},"applicable_packaging_material_types":{"type":"array","items":{"$ref":"#/components/schemas/Products.PackagingMaterialTypeViewModel"},"nullable":true},"applicable_taxonomy":{"type":"array","items":{"type":"string"},"nullable":true},"description":{"type":"string","nullable":true},"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true}}},"Products.PackagingRequirementViewModelArray":{"type":"array","items":{"$ref":"#/components/schemas/Products.PackagingRequirementViewModel"}},"Products.Patch.Api.V4.Product.ProductId.ProductId.Integer":{"type":"integer","format":"int64"},"Products.Patch.Api.V4.Product.ProductId.Variants.ProductId.Integer":{"type":"integer","format":"int64"},"Products.Patch.Api.V5.Product.ProductId.ProductId.Integer":{"type":"integer","format":"int64"},"Products.Patch.Api.V5.Product.ProductId.Variants.ProductId.Integer":{"type":"integer","format":"int64"},"Products.Post.Api.V2.Variant.VariantId.Channel.Metadata.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"}]},"Products.Post.Api.V2.Variant.VariantId.Channel.Metadata.VariantId.Integer":{"type":"integer","format":"int64"},"Products.Post.Api.V2.Variant.VariantId.ConvertToBundle.VariantId.Integer":{"type":"integer","format":"int64"},"Products.Post.Api.V2.Variant.VariantId.Merge.VariantId.Integer":{"type":"integer","format":"int64"},"Products.Post.Api.V4.Product.MoveVariants.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Products.Post.Api.V4.Product.MoveVariants.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Post.Api.V4.Product.ProductId.MoveVariants.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Products.Post.Api.V4.Product.ProductId.MoveVariants.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Post.Api.V4.Product.ProductId.MoveVariants.ProductId.Integer":{"type":"integer","format":"int64"},"Products.Post.Api.V4.Product.ProductId.Variants.ProductId.Integer":{"type":"integer","format":"int64"},"Products.Post.Api.V5.Product.MoveVariants.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Products.Post.Api.V5.Product.MoveVariants.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Post.Api.V5.Product.ProductId.MoveVariants.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Products.Post.Api.V5.Product.ProductId.MoveVariants.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Post.Api.V5.Product.ProductId.MoveVariants.ProductId.Integer":{"type":"integer","format":"int64"},"Products.Post.Api.V5.Product.ProductId.Variants.ProductId.Integer":{"type":"integer","format":"int64"},"Products.Post.Api.V5.Variant.VariantId.Channel.Metadata.Request.OneOf.AmazonChannelMetadataRequestModel.BaseChannelMetadataRequestModel.BigCommerceChannelMetadataRequestModel.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"},"oneOf":[{"$ref":"#/components/schemas/Products.AmazonChannelMetadataRequestModel"},{"$ref":"#/components/schemas/Products.BaseChannelMetadataRequestModel"},{"$ref":"#/components/schemas/Products.BigCommerceChannelMetadataRequestModel"},{"$ref":"#/components/schemas/Products.ShopifyChannelMetadataRequestModel"}]},"Products.Post.Api.V5.Variant.VariantId.Channel.Metadata.VariantId.Integer":{"type":"integer","format":"int64"},"Products.Post.Api.V5.Variant.VariantId.ConvertToBundle.VariantId.Integer":{"type":"integer","format":"int64"},"Products.Post.Api.V5.Variant.VariantId.Merge.VariantId.Integer":{"type":"integer","format":"int64"},"Products.ProblemDetails":{"type":"object","additionalProperties":{"additionalProperties":false},"properties":{"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"title":{"type":"string","nullable":true},"type":{"type":"string","nullable":true}}},"Products.ProductChannelMetadataModel":{"type":"object","properties":{"channel_id":{"type":"integer","format":"int64"},"channel_name":{"type":"string","nullable":true},"currency":{"type":"string","nullable":true},"id":{"type":"integer","format":"int64","nullable":true},"is_inventory_sync_enabled":{"type":"boolean"},"legacy_product_id":{"type":"integer","format":"int64","nullable":true},"platform":{"type":"string","nullable":true},"platform_identifier":{"type":"string","nullable":true},"platform_inventory_item_id":{"type":"string","nullable":true},"price":{"type":"number","format":"double"},"seller_sku":{"type":"string","nullable":true}}},"Products.ProductViewModel":{"type":"object","additionalProperties":false,"properties":{"category":{"$ref":"#/components/schemas/Products.EnumViewModel"},"created_on":{"type":"string","format":"date-time"},"id":{"type":"integer","format":"int64"},"name":{"type":"string","nullable":true},"sub_category":{"$ref":"#/components/schemas/Products.EnumViewModel"},"taxonomy":{"$ref":"#/components/schemas/Products.TaxonomyInformationViewModel"},"type":{"type":"string","nullable":true},"updated_on":{"type":"string","format":"date-time","nullable":true},"user_id":{"type":"integer","format":"int64"},"variants":{"type":"array","items":{"$ref":"#/components/schemas/Products.VariantViewModel"},"nullable":true}}},"Products.ProductViewModelPagedResponse":{"type":"object","additionalProperties":false,"properties":{"first":{"type":"string","nullable":true},"items":{"type":"array","items":{"$ref":"#/components/schemas/Products.ProductViewModel"},"nullable":true},"last":{"type":"string","nullable":true},"next":{"type":"string","nullable":true},"prev":{"type":"string","nullable":true}}},"Products.ProductViewModelV5":{"type":"object","additionalProperties":false,"properties":{"created_on":{"type":"string","format":"date-time"},"id":{"type":"integer","format":"int64"},"name":{"type":"string","nullable":true},"taxonomy":{"$ref":"#/components/schemas/Products.TaxonomyInformationViewModel"},"type":{"type":"string","nullable":true},"updated_on":{"type":"string","format":"date-time","nullable":true},"user_id":{"type":"integer","format":"int64"},"variants":{"type":"array","items":{"$ref":"#/components/schemas/Products.VariantViewModelV5"},"nullable":true}}},"Products.ProductViewModelV5PagedResponse":{"type":"object","additionalProperties":false,"properties":{"first":{"type":"string","nullable":true},"items":{"type":"array","items":{"$ref":"#/components/schemas/Products.ProductViewModelV5"},"nullable":true},"last":{"type":"string","nullable":true},"next":{"type":"string","nullable":true},"prev":{"type":"string","nullable":true}}},"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"}]},"Products.Put.Api.V2.Variant.VariantId.Channel.Metadata.ChannelMetadataId.VariantId.Integer":{"type":"integer","format":"int64"},"Products.Put.Api.V5.Variant.VariantId.Channel.Metadata.ChannelMetadataId.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Products.Put.Api.V5.Variant.VariantId.Channel.Metadata.ChannelMetadataId.ChannelMetadataId.Integer":{"type":"integer","format":"int64"},"Products.Put.Api.V5.Variant.VariantId.Channel.Metadata.ChannelMetadataId.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails":{"oneOf":[{"$ref":"#/components/schemas/Products.ProblemDetails"},{"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Put.Api.V5.Variant.VariantId.Channel.Metadata.ChannelMetadataId.Request.OneOf.AmazonChannelMetadataRequestModel.BaseChannelMetadataRequestModel.BigCommerceChannelMetadataRequestModel.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"},"oneOf":[{"$ref":"#/components/schemas/Products.AmazonChannelMetadataRequestModel"},{"$ref":"#/components/schemas/Products.BaseChannelMetadataRequestModel"},{"$ref":"#/components/schemas/Products.BigCommerceChannelMetadataRequestModel"},{"$ref":"#/components/schemas/Products.ShopifyChannelMetadataRequestModel"}]},"Products.Put.Api.V5.Variant.VariantId.Channel.Metadata.ChannelMetadataId.VariantId.Integer":{"type":"integer","format":"int64"},"Products.ReturnPreferencesRequestModel":{"type":"object","additionalProperties":false,"properties":{"backup_action_id":{"type":"integer","format":"int32","nullable":true},"instructions":{"type":"string","nullable":true},"primary_action_id":{"type":"integer","format":"int32"},"return_to_sender_backup_action_id":{"type":"integer","format":"int32","nullable":true},"return_to_sender_primary_action_id":{"type":"integer","format":"int32","nullable":true}}},"Products.ReturnPreferencesViewModel":{"type":"object","additionalProperties":false,"properties":{"backup_action":{"$ref":"#/components/schemas/Products.EnumViewModel"},"instructions":{"type":"string","nullable":true},"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"}}},"Products.ReviewsPendingType":{"type":"integer","format":"int32","enum":[0,1,2,3,4]},"Products.SerialScanRequestModel":{"type":"object","additionalProperties":false,"properties":{"exact_character_length":{"type":"integer","format":"int32","nullable":true},"is_enabled":{"type":"boolean"},"prefix":{"type":"string","nullable":true},"suffix":{"type":"string","nullable":true}}},"Products.SerialScanViewModel":{"type":"object","additionalProperties":false,"properties":{"exact_character_length":{"type":"integer","format":"int32","nullable":true},"is_enabled":{"type":"boolean"},"prefix":{"type":"string","nullable":true},"suffix":{"type":"string","nullable":true}}},"Products.ShopifyChannelMetadataRequestModel":{"type":"object","description":"Shopify Sales Channel Information","properties":{"platform":{"type":"string","readOnly":true,"nullable":true}},"allOf":[{"$ref":"#/components/schemas/Products.BaseChannelMetadataRequestModel"}]},"Products.ShopifyChannelMetadataViewModel":{"type":"object","allOf":[{"$ref":"#/components/schemas/Products.ChannelMetadataViewModel"}]},"Products.ShopifyProductChannelMetadataModel":{"type":"object","allOf":[{"$ref":"#/components/schemas/Products.BaseProductChannelMetadataModel"}]},"Products.TaxonomyInformationViewModel":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32","nullable":true},"name":{"type":"string","nullable":true},"parent_id":{"type":"integer","format":"int32","nullable":true},"parent_name":{"type":"string","nullable":true},"path":{"type":"string","nullable":true}}},"Products.TaxonomyViewModel":{"type":"object","properties":{"children":{"type":"array","items":{"$ref":"#/components/schemas/Products.ChildTaxonomyViewModel"},"nullable":true},"parent":{"oneOf":[{"$ref":"#/components/schemas/Products.BaseTaxonomyViewModel"},{"$ref":"#/components/schemas/Products.ChildTaxonomyViewModel"},{"$ref":"#/components/schemas/Products.TaxonomyViewModel"}],"nullable":true}},"allOf":[{"$ref":"#/components/schemas/Products.BaseTaxonomyViewModel"}]},"Products.TaxonomyViewModelArray":{"type":"array","items":{"$ref":"#/components/schemas/Products.TaxonomyViewModel"}},"Products.UpdateProductRequestModelV3":{"type":"object","description":"The product to update","properties":{"variants":{"type":"array","items":{"$ref":"#/components/schemas/Products.UpdateProductVariantRequestModelV3"},"nullable":true}},"allOf":[{"$ref":"#/components/schemas/Products.BaseProductRequestModel"}]},"Products.UpdateProductRequestModelV5":{"type":"object","example":{"id":0,"name":"string","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},"barcodes":[{"sticker_url":"string","value":"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}]},"properties":{"id":{"type":"integer","description":"Unique reference ID for the product","format":"int64"},"variants":{"type":"array","items":{"$ref":"#/components/schemas/Products.UpdateProductVariantRequestModelV5"},"nullable":true}},"allOf":[{"$ref":"#/components/schemas/Products.BaseProductRequestModel"}]},"Products.UpdateProductVariantModelV5":{"type":"object","example":{"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},"barcodes":[{"sticker_url":"string","value":"string"}],"bundle_definition":[{"quantity":0,"variant_id":0}],"channel_metadata":[{"asin":"string","channel_id":0,"channel_name":"string","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","currency":"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},"reviews_pending":[0],"sku":"string","status":1,"upc":"string","weight":0.1},"properties":{"barcodes":{"type":"array","items":{"$ref":"#/components/schemas/Products.BarcodeModel"},"nullable":true},"id":{"type":"integer","format":"int64"}},"allOf":[{"$ref":"#/components/schemas/Products.BaseProductVariantModel"}]},"Products.UpdateProductVariantRequestModel":{"type":"object","properties":{"id":{"type":"integer","format":"int64"}},"allOf":[{"$ref":"#/components/schemas/Products.BaseProductVariantRequestModel"}]},"Products.UpdateProductVariantRequestModelV3":{"type":"object","properties":{"barcode_sticker_url":{"type":"string","nullable":true}},"allOf":[{"$ref":"#/components/schemas/Products.UpdateProductVariantRequestModel"}]},"Products.UpdateProductVariantRequestModelV5":{"type":"object","properties":{"barcodes":{"type":"array","items":{"$ref":"#/components/schemas/Products.BarcodeRequestModel"},"nullable":true},"id":{"type":"integer","format":"int64"}},"allOf":[{"$ref":"#/components/schemas/Products.BaseProductVariantRequestModel"}]},"Products.VariantStatus":{"type":"integer","format":"int32","enum":[1,2,3]},"Products.VariantToMigrate":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string","nullable":true}}},"Products.VariantViewModel":{"type":"object","properties":{"barcode":{"type":"string","nullable":true},"barcode_sticker_url":{"type":"string","nullable":true},"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"}]},"nullable":true}},"allOf":[{"$ref":"#/components/schemas/Products.VariantViewModelBase"}]},"Products.VariantViewModelArray":{"type":"array","items":{"$ref":"#/components/schemas/Products.VariantViewModel"}},"Products.VariantViewModelBase":{"type":"object","properties":{"additional_hazmat_attributes":{"$ref":"#/components/schemas/Products.AdditionalHazmatAttributesViewModel"},"associated_bundles":{"type":"array","items":{"$ref":"#/components/schemas/Products.AssociatedBundlesViewModel"},"nullable":true},"bundle_definition":{"type":"array","items":{"$ref":"#/components/schemas/Products.BundleDefinitionViewModel"},"nullable":true},"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","nullable":true},"id":{"type":"integer","format":"int64"},"inventory":{"$ref":"#/components/schemas/Products.InventoryViewModel"},"is_digital":{"type":"boolean"},"is_image_uploaded":{"type":"boolean"},"lot_information":{"$ref":"#/components/schemas/Products.LotInformationViewModel"},"merge_children":{"type":"array","items":{"$ref":"#/components/schemas/Products.MergedChildrenViewModel"},"nullable":true},"name":{"type":"string","nullable":true},"packaging_material_type":{"$ref":"#/components/schemas/Products.EnumViewModel"},"packaging_requirement":{"$ref":"#/components/schemas/Products.EnumViewModel"},"return_preferences":{"$ref":"#/components/schemas/Products.ReturnPreferencesViewModel"},"reviews_pending":{"type":"array","items":{"type":"string"},"nullable":true},"sku":{"type":"string","nullable":true},"status":{"type":"string","nullable":true},"upc":{"type":"string","nullable":true},"updated_on":{"type":"string","format":"date-time","nullable":true},"weight":{"$ref":"#/components/schemas/Products.WeightViewModel"}}},"Products.VariantViewModelV5":{"type":"object","properties":{"barcodes":{"type":"array","items":{"$ref":"#/components/schemas/Products.BarcodeViewModel"},"nullable":true},"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"}]},"nullable":true}},"allOf":[{"$ref":"#/components/schemas/Products.VariantViewModelBase"}]},"Products.VariantViewModelV5Array":{"type":"array","items":{"$ref":"#/components/schemas/Products.VariantViewModelV5"}},"Products.WeightViewModel":{"type":"object","additionalProperties":false,"properties":{"unit":{"type":"string","nullable":true},"weight":{"type":"number","format":"double"}}},"Receiving.AssignOrderToFulfillmentCenterModel":{"type":"object","description":"Model containing information that assigns a receiving order to a fulfillment center.\r\nIf the fulfillment center provided is in a receiving hub region, then the response will be the receiving hub location.","additionalProperties":false,"required":["id"],"properties":{"id":{"type":"integer","description":"ID of the fulfillment center to assign this receiving order to","format":"int32"}}},"Receiving.FulfillmentCenterViewModel":{"type":"object","description":"Information about a fulfillment center","additionalProperties":false,"properties":{"address1":{"type":"string","description":"Address line one of the fulfillment center","example":"5900 W Ogden Ave","nullable":true},"address2":{"type":"string","description":"Address line two of the fulfillment center","example":"Suite 100","nullable":true},"city":{"type":"string","description":"City the fulfillment center is located in","example":"Cicero","nullable":true},"country":{"type":"string","description":"Country the fulfillment center is located in","example":"USA","nullable":true},"email":{"type":"string","description":"Email contact for the fulfillment center","example":"example@example.com","nullable":true},"id":{"type":"integer","description":"Unique identifier of the fulfillment center","format":"int32"},"name":{"type":"string","description":"Name of the fulfillment center","example":"Cicero (IL)","nullable":true},"phone_number":{"type":"string","description":"Phone number contact for the fulfillment center","example":"555-555-5555","nullable":true},"state":{"type":"string","description":"State the fulfillment center is located in","example":"IL","nullable":true},"timezone":{"type":"string","description":"Timezone the fulfillment center is located in","example":"Central Standard Time","nullable":true},"zip_code":{"type":"string","description":"Postal code of the fulfillment center","example":"60804","nullable":true}}},"Receiving.PackageType":{"type":"string","enum":["Package","Pallet","FloorLoadedContainer"]},"Receiving.PackingType":{"type":"string","enum":["EverythingInOneBox","OneSkuPerBox","MultipleSkuPerBox"]},"Receiving.Post.2.0.Receiving.Set.External.Sync.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Receiving.Post.3.0.Receiving.Unprocessable.Entity.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Receiving.ProblemDetails":{"type":"object","additionalProperties":{"additionalProperties":false},"properties":{"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"title":{"type":"string","nullable":true},"type":{"type":"string","nullable":true}}},"Receiving.Put.Api.Receiving.Id.Tag.Authorization.String":{"type":"string"},"Receiving.Put.Api.Receiving.Id.Tag.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Receiving.Put.Api.Receiving.Id.Tag.Id.Integer":{"type":"integer","format":"int32"},"Receiving.Put.Api.Receiving.Id.Tag.Not.Found.Object":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"Receiving.ReceivingStatus":{"type":"string","enum":["Awaiting","Processing","Completed","Cancelled","Incomplete","Arrived","PartiallyArrived","PartiallyArrivedAtHub","ArrivedAtHub","ProcessingAtHub","InternalTransfer"]},"Receiving.TagModel":{"type":"object","additionalProperties":false,"required":["name","value"],"properties":{"name":{"type":"string","maxLength":50,"minLength":1},"value":{"type":"string","maxLength":500,"minLength":1}}},"Receiving.UpdateExternalSyncModel":{"type":"object","example":{"ids":[0],"is_external_sync":true},"additionalProperties":false,"properties":{"ids":{"type":"array","items":{"type":"integer","format":"int32"},"nullable":true},"is_external_sync":{"type":"boolean"}}},"Receiving.UpdateReceivingTagsRequest":{"type":"object","example":{"data":[{"name":"string","value":"string"}]},"additionalProperties":false,"required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Receiving.TagModel"}}}},"Receiving.UpdateReceivingTagsResponse":{"type":"object","additionalProperties":false,"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Receiving.TagModel"},"nullable":true},"total_records":{"type":"integer","format":"int32"}}},"Receiving.V2.InventoryQuantityViewModel":{"type":"object","additionalProperties":false,"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","nullable":true},"stowed_quantity":{"type":"integer","description":"Quantity of the inventory item stowed by the warehouse","format":"int32"}}},"Receiving.V2.ReceivingOrderStatusHistoryViewModel":{"type":"object","description":"View model for receiving order status history","additionalProperties":false,"properties":{"id":{"type":"integer","description":"Unique id of the status","format":"int32"},"status":{"type":"string","description":"Name of the status","example":"Processing","nullable":true},"timestamp":{"type":"string","description":"Timestamp when the status was recorded","format":"date-time"}}},"Receiving.V2.WarehouseReceivingOrderViewModel":{"type":"object","additionalProperties":false,"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","nullable":true},"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"},"external_sync_timestamp":{"type":"string","description":"The timestamp in UTC when a 3rd party integrator has set in our system","format":"date-time","nullable":true},"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","description":"Inventory items and quantities within the WRO","items":{"$ref":"#/components/schemas/Receiving.V2.InventoryQuantityViewModel"},"nullable":true},"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","nullable":true},"status":{"$ref":"#/components/schemas/Receiving.ReceivingStatus"},"status_history":{"type":"array","description":"The history of status changes for this receiving order","items":{"$ref":"#/components/schemas/Receiving.V2.ReceivingOrderStatusHistoryViewModel"},"nullable":true}}},"Receiving.V3.AddBoxItemToBoxV3Model":{"type":"object","description":"Information about an inventory item contained inside a receiving order box.\r\nAt least one of inventory_id or sku must be provided.","additionalProperties":false,"required":["quantity"],"properties":{"inventory_id":{"type":"integer","description":"Unique inventory id of the items in the box (optional if sku is provided)","format":"int32","nullable":true},"lot_date":{"type":"string","description":"Lot expiration date for the items in the box","format":"date-time","nullable":true},"lot_number":{"type":"string","description":"Lot number of the items in the box","example":"2222","nullable":true},"quantity":{"type":"integer","description":"Quantity of the items in the box","format":"int32","maximum":2147483647.0,"minimum":1.0},"sku":{"type":"string","description":"SKU identifier for the items in the box (optional if inventory_id is provided)","nullable":true}}},"Receiving.V3.AddBoxToOrderV3Model":{"type":"object","description":"Information about a box shipment to be added to a V3 receiving order","additionalProperties":false,"required":["box_items","tracking_number"],"properties":{"box_items":{"type":"array","description":"Items contained in this box. A receiving order may reference at most 10,000 unique inventory items (SKUs) across all of its boxes; exceeding this returns a 422 with the WRO_UNIQUE_SKU_LIMIT_EXCEEDED reason code. The limit applies to distinct inventory_ids across the whole order, not to a single box.","items":{"$ref":"#/components/schemas/Receiving.V3.AddBoxItemToBoxV3Model"}},"tracking_number":{"type":"string","description":"Tracking number for the box shipment","minLength":1,"example":"860C8CDC8F0B4FC7AB69AC86C20539EC"}}},"Receiving.V3.CreateReceivingOrderV3Model":{"type":"object","description":"Information to create a new receiving order","example":{"box_packaging_type":"EverythingInOneBox","boxes":[{"box_items":[{"inventory_id":0,"lot_date":"2019-08-24T14:15:22Z","lot_number":"2222","quantity":1,"sku":"string"}],"tracking_number":"860C8CDC8F0B4FC7AB69AC86C20539EC"}],"expected_arrival_date":"2019-08-24T14:15:22Z","final_destination_fulfillment_center_id":0,"freight":{"bol_number":"string","carrier":"string","container_number":"string","freight_forwarder":"string","notes":"string","vessel_name":"string"},"fulfillment_center":{"id":0},"package_type":"Package","purchase_order_number":"string"},"additionalProperties":false,"required":["boxes","box_packaging_type","expected_arrival_date","fulfillment_center","package_type"],"properties":{"box_packaging_type":{"$ref":"#/components/schemas/Receiving.PackingType"},"boxes":{"type":"array","description":"Box shipments to be added to this receiving order","items":{"$ref":"#/components/schemas/Receiving.V3.AddBoxToOrderV3Model"}},"expected_arrival_date":{"type":"string","description":"Expected arrival date of all the box shipments in this receiving order","format":"date-time"},"final_destination_fulfillment_center_id":{"type":"integer","description":"Spoke site this receiving order is being routed to","format":"int32","nullable":true},"freight":{"description":"Optional container/freight metadata for this receiving order","allOf":[{"$ref":"#/components/schemas/Receiving.V3.FreightMetadataV3Model"}],"nullable":true},"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","nullable":true}}},"Receiving.V3.FreightMetadataV3Model":{"type":"object","description":"Optional container/freight metadata for a receiving order","properties":{"bol_number":{"type":"string","description":"Bill of Lading number (the BOL number string, distinct from any uploaded BOL document)","maxLength":100,"nullable":true},"carrier":{"type":"string","description":"Carrier name (e.g. Maersk, DHL, FedEx)","maxLength":100,"nullable":true},"container_number":{"type":"string","description":"Shipping container number","maxLength":100,"nullable":true},"freight_forwarder":{"type":"string","description":"Freight forwarder company name","maxLength":100,"nullable":true},"notes":{"type":"string","description":"Free-text freight notes","maxLength":2000,"nullable":true},"vessel_name":{"type":"string","description":"Vessel (ship) name","maxLength":100,"nullable":true}}},"Receiving.V3.FreightMetadataViewModel":{"type":"object","description":"Container/freight metadata returned for a receiving order","properties":{"bol_number":{"type":"string","description":"Bill of Lading number (the BOL number string, distinct from any uploaded BOL document)","nullable":true},"carrier":{"type":"string","description":"Carrier name (e.g. Maersk, DHL, FedEx)","nullable":true},"container_number":{"type":"string","description":"Shipping container number","nullable":true},"freight_forwarder":{"type":"string","description":"Freight forwarder company name","nullable":true},"notes":{"type":"string","description":"Free-text freight notes","nullable":true},"vessel_name":{"type":"string","description":"Vessel (ship) name","nullable":true}}},"Receiving.V3.WarehouseReceivingOrderViewModel":{"type":"object","additionalProperties":false,"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","nullable":true},"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"},"external_sync_timestamp":{"type":"string","description":"The timestamp in UTC when a 3rd party integrator has set in our system","format":"date-time","nullable":true},"freight":{"description":"Optional container/freight metadata for this receiving order (null when none was provided)","allOf":[{"$ref":"#/components/schemas/Receiving.V3.FreightMetadataViewModel"}],"nullable":true},"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","description":"Inventory items and quantities within the WRO","items":{"$ref":"#/components/schemas/Receiving.V2.InventoryQuantityViewModel"},"nullable":true},"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","nullable":true},"status":{"$ref":"#/components/schemas/Receiving.ReceivingStatus"},"status_history":{"type":"array","description":"The history of status changes for this receiving order","items":{"$ref":"#/components/schemas/Receiving.V2.ReceivingOrderStatusHistoryViewModel"},"nullable":true}}},"Returns.ActionRequestedDto":{"type":"object","description":"The details of the action requested for inventory","additionalProperties":false,"properties":{"action":{"type":"string","description":"The action to take","nullable":true},"action_type":{"type":"string","description":"The source of the action to take, i.e. Inventory Default or Overriden by Merchant at creation","nullable":true},"instructions":{"type":"string","description":"The instructions for how to take the action given by inventory owning Merchant","nullable":true}}},"Returns.ActionTakenDto":{"type":"object","description":"The details of an action taken for inventory item in the return","additionalProperties":false,"properties":{"action":{"type":"string","description":"The return action taken","nullable":true},"action_reason":{"type":"string","description":"The reason the action was taken","nullable":true},"image_url":{"type":"string","description":"Image of inventory processed with this action.","format":"uri","nullable":true},"quantity_processed":{"type":"integer","description":"The quantity of inventory items processed with this reason and action","format":"int32"}}},"Returns.ChannelDto":{"type":"object","description":"The details of a Channel","additionalProperties":false,"properties":{"id":{"type":"integer","description":"Unique Id of the channel","format":"int32"},"name":{"type":"string","description":"Name given to the channel","nullable":true}}},"Returns.CreateReturnLabelRequest":{"type":"object","description":"Request to purchase a return shipping label for an existing return order. Either shipment_id or origin_address must be provided.","example":{"origin_address":{"city":"Chicago","company":"ACME Corp","country":"US","email":"jane@example.com","name":"Jane Doe","phone":"312-555-0100","state":"IL","street1":"123 Main St","street2":"Apt 4B","zip_code":"60601"},"shipment_id":98765,"shipping_service":"ReturnsStandard"},"additionalProperties":false,"properties":{"label_format":{"type":"string","description":"Optional label file format. Accepted values: PDF, PNG. If not provided, carrier default format is used","enum":["PDF","PNG"],"nullable":true},"origin_address":{"description":"Customer return address. Required if shipment_id is not provided. Either shipment_id or origin_address must be provided.","$ref":"#/components/schemas/Returns.ReturnLabelAddress"},"shipment_id":{"type":"integer","description":"Original outbound shipment ID. If provided, origin address is extracted from the shipment record. Either shipment_id or origin_address must be provided.","format":"int32","nullable":true},"shipping_service":{"type":"string","description":"Ship option name (e.g. \"ReturnsStandard\"). Resolved against available return ship options for the merchant. Falls back to cheapest available option if not matched","nullable":true}}},"Returns.CreateReturnLabelResponse":{"type":"object","description":"Return shipping label details including tracking number, label URL, carrier information, and rate.","additionalProperties":false,"properties":{"barcode":{"type":"array","description":"Carrier barcode values from label purchase. Currently null in V1","items":{"type":"string"},"nullable":true},"carrier":{"type":"string","description":"Name of the shipping carrier (e.g. USPS, UPS, FedEx)"},"carrier_service":{"type":"string","description":"Specific carrier service used (e.g. Ground Advantage, Priority Mail)"},"label_request_id":{"type":"integer","description":"Unique identifier for this label purchase.","format":"int64","nullable":true},"label_url":{"type":"string","description":"URL to download the shipping label image. Format follows the label_format request parameter (PDF or PNG) when the carrier supports it; otherwise the carrier's default format is returned."},"label_zpl_url":{"type":"string","description":"URL to download the shipping label in ZPL format for thermal printers","nullable":true},"purchase_date":{"type":"string","description":"Date and time when the label was purchased","format":"date-time"},"qrcode_url":{"type":"string","description":"QR code image URL for label-less returns. Currently null in V1","nullable":true},"rate":{"type":"array","description":"Shipping rate details including amount and currency","items":{"$ref":"#/components/schemas/Returns.RateInfo"}},"return_id":{"type":"integer","description":"The ID of the return order this label was purchased for","format":"int32"},"shipment_rate_id":{"type":"integer","description":"Unique identifier for the shipment rate from the labeling service","format":"int64"},"tracking_number":{"type":"string","description":"Carrier tracking number for the return shipment"},"tracking_url":{"type":"string","description":"URL to track the return shipment on the carrier website","nullable":true}}},"Returns.CreateReturnRequest":{"type":"object","description":"The request payload for creating a Return of inventory.","example":{"fulfillment_center":{"id":10,"name":"Cicero (CHI3)"},"inventory":[{"id":1279396,"lot_date":null,"lot_number":null,"quantity":2,"requested_action":"Restock"}],"original_shipment_id":98765,"purchase_label":true,"reference_id":"RMA-2026-00123","shipping_service":"ReturnsStandard","tracking_number":"1Z999AA10123456784"},"additionalProperties":false,"required":["fulfillment_center","reference_id","inventory"],"properties":{"fulfillment_center":{"$ref":"#/components/schemas/Returns.Facility"},"inventory":{"type":"array","description":"Array of inventory items being returned","minItems":1,"items":{"$ref":"#/components/schemas/Returns.ReturnInventory"}},"label_format":{"type":"string","description":"Optional label file format. Accepted values: PDF, PNG. If not provided, carrier default format is used. Only used when purchase_label is true","enum":["PDF","PNG"],"nullable":true},"original_shipment_id":{"type":"integer","description":"Shipment from which the items in the return originated. Required when purchase_label is true","format":"int32","nullable":true},"purchase_label":{"type":"boolean","description":"If true, purchases a return shipping label after creating the return order. Requires original_shipment_id","default":false,"nullable":true},"reference_id":{"type":"string","description":"Client-defined external unique identifier for the return order. If tracking id is not provided, this value must appear on the box label as RMA","maxLength":50},"shipping_service":{"type":"string","description":"Ship option name (e.g. \"ReturnsStandard\") for label purchase. Only used when purchase_label is true. Resolved against available return ship options for the merchant. Falls back to cheapest if not matched","nullable":true},"tracking_number":{"type":"string","description":"Tracking number for the return shipment","maxLength":500,"nullable":true}}},"Returns.CreateReturnWithLabelResponse":{"type":"object","description":"Response from creating a return order. When purchase_label is true and the label purchase succeeds, both return and label are populated. When purchase_label is false, only return is populated. When purchase_label is true but the label purchase fails, return is populated, label is null, and label_error explains the failure.","additionalProperties":false,"properties":{"label":{"description":"Return shipping label details. Populated only when purchase_label is true and the label purchase succeeded. Null when purchase_label is false or the label purchase failed (in which case label_error explains why).","$ref":"#/components/schemas/Returns.CreateReturnLabelResponse","nullable":true},"label_error":{"type":"string","description":"Human-readable error message if label purchase was requested but failed. The return is still created in this case — only the label step failed.","nullable":true},"return":{"description":"The created return order details","$ref":"#/components/schemas/Returns.PublicReturnDto"}}},"Returns.Facility":{"type":"object","description":"A Facility to process Returns.","additionalProperties":false,"properties":{"id":{"type":"integer","description":"Unique identifier of the facility","format":"int32"},"name":{"type":"string","description":"Name of the facility (It is optional because public API integrations do not pass this)","nullable":true}}},"Returns.FulfillmentCenterDto":{"type":"object","description":"The details of a Fulfillment Center","additionalProperties":false,"properties":{"id":{"type":"integer","description":"Unique id of the fulfillment center","format":"int32"},"name":{"type":"string","description":"Name give to the fulfillment center","nullable":true}}},"Returns.Get.Api.Experimental.Returns.Search.Api.Version.String":{"type":"string","default":"1.0"},"Returns.Get.Api.Experimental.Returns.Search.CompletedEndDate.String":{"type":"string","format":"date-time"},"Returns.Get.Api.Experimental.Returns.Search.CompletedStartDate.String":{"type":"string","format":"date-time"},"Returns.Get.Api.Experimental.Returns.Search.Cursor.Integer":{"type":"integer","format":"int32","maximum":2147483647.0,"minimum":1.0,"example":1},"Returns.Get.Api.Experimental.Returns.Search.EndDate.String":{"type":"string","format":"date-time"},"Returns.Get.Api.Experimental.Returns.Search.FulfillmentCenterIds.String":{"type":"string"},"Returns.Get.Api.Experimental.Returns.Search.Ids.String":{"type":"string"},"Returns.Get.Api.Experimental.Returns.Search.InventoryIds.String":{"type":"string"},"Returns.Get.Api.Experimental.Returns.Search.Limit.Integer":{"type":"integer","format":"int32","example":25},"Returns.Get.Api.Experimental.Returns.Search.OK.Page.Number.String":{"type":"string","description":"Current page number","format":""},"Returns.Get.Api.Experimental.Returns.Search.OK.Page.Size.String":{"type":"string","description":"Page size","format":""},"Returns.Get.Api.Experimental.Returns.Search.OK.Total.Count.String":{"type":"string","description":"Total records","format":""},"Returns.Get.Api.Experimental.Returns.Search.OK.Total.Pages.String":{"type":"string","description":"Total pages","format":""},"Returns.Get.Api.Experimental.Returns.Search.OriginalShipmentIds.String":{"type":"string"},"Returns.Get.Api.Experimental.Returns.Search.ReferenceIds.String":{"type":"string"},"Returns.Get.Api.Experimental.Returns.Search.ReturnActions.String":{"type":"string"},"Returns.Get.Api.Experimental.Returns.Search.ReturnTypes.String":{"type":"string"},"Returns.Get.Api.Experimental.Returns.Search.SearchTerm.String":{"type":"string"},"Returns.Get.Api.Experimental.Returns.Search.Shipbob.Channel.Id.Integer":{"type":"integer","format":"int32"},"Returns.Get.Api.Experimental.Returns.Search.Sortby.String":{"type":"string"},"Returns.Get.Api.Experimental.Returns.Search.StartDate.String":{"type":"string","format":"date-time"},"Returns.Get.Api.Experimental.Returns.Search.Status.String":{"type":"string"},"Returns.Get.Api.Experimental.Returns.Search.StoreOrderIds.String":{"type":"string"},"Returns.Get.Api.Experimental.Returns.Search.TrackingNumbers.String":{"type":"string"},"Returns.InventoryItemDto":{"type":"object","description":"The details of the inventory in the return order","additionalProperties":false,"properties":{"action_requested":{"$ref":"#/components/schemas/Returns.ActionRequestedDto"},"action_taken":{"type":"array","description":"List of actions taken","items":{"$ref":"#/components/schemas/Returns.ActionTakenDto"},"nullable":true},"barcodes":{"type":"array","description":"List of barcodes associated with the inventory item","items":{"type":"string"},"nullable":true},"bundle_parent_sku":{"type":"string","description":"SKU of the parent bundle if this item was expanded from a bundle. Null for non-bundle items","nullable":true},"id":{"type":"integer","description":"Unique id of the inventory","format":"int32"},"lot_information":{"allOf":[{"$ref":"#/components/schemas/Returns.LotInformationDto"}],"nullable":true},"name":{"type":"string","description":"Name of the product","nullable":true},"quantity":{"type":"integer","description":"Number of inventory that is being returned","format":"int32"},"sku":{"type":"string","description":"Stock keeping unit identifier for the inventory item","nullable":true}}},"Returns.InvoiceDto":{"type":"object","description":"The invoice amount and curency","properties":{"amount":{"type":"number","description":"Amount being charged","format":"double","nullable":true},"currency_code":{"type":"string","description":"Currency code of amount","nullable":true}}},"Returns.LotInformationDto":{"type":"object","description":"Lot information associated with a specific inventory item.","properties":{"expiration":{"type":"string","description":"The expiration date for this lot.","format":"date-time","nullable":true},"minimumShelfLife":{"type":"integer","description":"A minimum amount of time in days this product can be safely returned to the shelf without expiring.","format":"int32","nullable":true},"number":{"type":"string","description":"An alphanumeric string uniquely identifying this lot of produced inventory.","nullable":true}}},"Returns.Post.Api.Experimental.Return.Api.Version.String":{"type":"string","default":"1.0"},"Returns.Post.Api.Experimental.Return.CreationSourceId.Integer":{"type":"integer","description":"Source of the return creation. Defaults to 3 (API)","format":"int32","default":3},"Returns.Post.Api.Experimental.Return.Id.Label.Api.Version.String":{"type":"string","default":"1.0"},"Returns.Post.Api.Experimental.Return.Id.Label.Id.Integer":{"type":"integer","description":"The unique identifier of the return order","format":"int32"},"Returns.Post.Api.Experimental.Return.Id.Label.Shipbob.Channel.Id.Integer":{"type":"string","description":"The unique identifier of the channel to scope this request to","format":"int32"},"Returns.Post.Api.Experimental.Return.Shipbob.Channel.Id.Integer":{"type":"string","description":"The unique identifier of the channel to scope this request to","format":"int32"},"Returns.ProblemDetails":{"type":"object","description":"RFC 7807 Problem Details — standard error response body used across ShipBob public APIs.","additionalProperties":{"additionalProperties":false},"properties":{"detail":{"type":"string","description":"Human-readable explanation specific to this occurrence of the problem.","nullable":true},"instance":{"type":"string","description":"URI reference identifying the specific occurrence.","nullable":true},"status":{"type":"integer","description":"HTTP status code.","format":"int32","nullable":true},"title":{"type":"string","description":"Short, human-readable summary of the problem.","nullable":true},"type":{"type":"string","description":"URI reference identifying the problem type.","nullable":true}}},"Returns.PublicReturnDto":{"type":"object","description":"The details of a public return order, including the transactions and inventory items","additionalProperties":false,"properties":{"arrived_date":{"type":"string","description":"The date and time when the return arrived at the fulfillment center","format":"date-time","nullable":true},"awaiting_arrival_date":{"type":"string","description":"The date and time when the return entered Awaiting Arrival status","format":"date-time","nullable":true},"cancelled_date":{"type":"string","description":"The date and time when the return was cancelled, if applicable","format":"date-time","nullable":true},"channel":{"$ref":"#/components/schemas/Returns.ChannelDto"},"completed_date":{"type":"string","description":"The date and time for when the return order was completely processed","format":"date-time","nullable":true},"customer_name":{"type":"string","description":"Name of merchant that return belongs to","nullable":true},"fulfillment_center":{"$ref":"#/components/schemas/Returns.FulfillmentCenterDto"},"id":{"type":"integer","description":"Unique id of the return order","format":"int32"},"insert_date":{"type":"string","description":"The date and time for when the return order was created","format":"date-time"},"inventory":{"type":"array","description":"List of inventory items in return order","items":{"$ref":"#/components/schemas/Returns.InventoryItemDto"},"nullable":true},"invoice":{"allOf":[{"$ref":"#/components/schemas/Returns.InvoiceDto"}],"nullable":true},"original_shipment_id":{"type":"integer","description":"ShipmentId for which return was created","format":"int32","nullable":true},"processing_date":{"type":"string","description":"The date and time when the return started processing","format":"date-time","nullable":true},"reference_id":{"type":"string","description":"Unique reference id of the return order. Created by merchant if a regular return.","nullable":true},"return_type":{"type":"string","description":"Type of the return, i.e. Regular, RTS","nullable":true},"shipment_tracking_number":{"type":"string","description":"The tracking number of the original shipment","nullable":true},"status":{"type":"string","description":"Status of the return order, i.e. `Awaiting Arrival`, `Arrived`, `Processing`, `Completed` `Cancelled`","nullable":true},"status_history":{"type":"array","description":"List of status history in return order","items":{"$ref":"#/components/schemas/Returns.StatusHistoryDto"},"nullable":true},"store_order_id":{"type":"string","description":"Reference to external order id","nullable":true},"tracking_number":{"type":"string","description":"The tracking number of the return shipping label","nullable":true},"transactions":{"type":"array","description":"List of transactions that make up the billable amount to invoice a merchant","items":{"$ref":"#/components/schemas/Returns.TransactionDto"},"nullable":true}}},"Returns.PublicReturnDtoPagedUrlResultDto":{"type":"object","additionalProperties":false,"properties":{"first":{"type":"string","description":"Return url for first cursor","format":"uri","nullable":true},"items":{"type":"array","description":"Return records","items":{"$ref":"#/components/schemas/Returns.PublicReturnDto"},"nullable":true},"last":{"type":"string","description":"Return url for last cursor","format":"uri","nullable":true},"next":{"type":"string","description":"Return url for next cursor","format":"uri","nullable":true},"prev":{"type":"string","description":"Return url for prev cursor","format":"uri","nullable":true}}},"Returns.RateInfo":{"type":"object","description":"Shipping rate amount and currency details.","example":{"amount":850,"currency_code":"USD"},"additionalProperties":false,"properties":{"amount":{"type":"integer","description":"Shipping rate amount in cents (e.g. 850 = $8.50). Null when the merchant-facing rate is not known for the return.","format":"int64","example":850,"nullable":true},"currency_code":{"type":"string","description":"ISO 4217 currency code (e.g. USD). Null when the merchant-facing rate is not known for the return.","example":"USD","nullable":true}}},"Returns.ReturnAction":{"type":"string","enum":["Default","Restock","Quarantine","Dispose","Donation"]},"Returns.ReturnInventory":{"type":"object","description":"An inventory being returned, includes the quantity and an override for the return action.","additionalProperties":false,"required":["id","quantity","requested_action"],"properties":{"id":{"type":"integer","description":"ID of the inventory item to return.","format":"int32"},"lot_date":{"type":"string","description":"Lot date associated with the inventory item, if applicable.","format":"date-time","nullable":true},"lot_number":{"type":"string","description":"Lot number associated with the inventory item, if applicable.","nullable":true},"quantity":{"type":"integer","description":"Quantity of the returned inventory item in the return.","format":"int32"},"requested_action":{"$ref":"#/components/schemas/Returns.ReturnAction"}}},"Returns.ReturnLabelAddress":{"type":"object","description":"Customer address used as the origin (from) address on the return shipping label.","additionalProperties":false,"properties":{"city":{"type":"string","description":"City name","nullable":true},"company":{"type":"string","description":"Company or business name","nullable":true},"country":{"type":"string","description":"ISO 3166-1 alpha-2 country code (e.g. US, CA, GB)","nullable":true},"email":{"type":"string","description":"Contact email address","nullable":true},"name":{"type":"string","description":"Full name of the person at the return origin address","nullable":true},"phone":{"type":"string","description":"Contact phone number","nullable":true},"state":{"type":"string","description":"State or province code (e.g. IL, NY, CA)","nullable":true},"street1":{"type":"string","description":"Primary street address line","nullable":true},"street2":{"type":"string","description":"Secondary street address line (apartment, suite, unit, etc.)","nullable":true},"zip_code":{"type":"string","description":"Postal or ZIP code","nullable":true}}},"Returns.SortOrder":{"type":"string","enum":["Desc","Asc"]},"Returns.StatusHistoryDto":{"type":"object","description":"Status history","additionalProperties":false,"properties":{"status":{"type":"string","description":"Status to change","nullable":true},"timestamp":{"type":"string","description":"Date change status","format":"date-time"}}},"Returns.TransactionDto":{"type":"object","description":"The details of a transaction charged to the return order","additionalProperties":false,"properties":{"amount":{"type":"number","description":"The amount charged for this transaction","format":"double"},"transaction_type":{"type":"string","description":"The type of transaction","nullable":true}}},"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","additionalProperties":false,"properties":{"linnworks_locations":{"type":"string","nullable":true},"shipbob_fullfilment_center":{"type":"string","nullable":true}}},"TriggerSync.integrationRequest_linnworksConfig":{"type":"object","example":{"config":{"allowedHeadersForLogging":"string","confirmFulfillmentForProcessedOrders":true,"enableLinnworksTagCreation":true,"fcToWHMap":[{"linnworks_locations":"string","shipbob_fullfilment_center":"string"}],"inventorySync":true,"linnworksApiUrl":"string","linnworksAvailableLocationsSelected":["string"],"logErrorRequestAndResponseData":true,"logRequestResponseHeader":true,"lookBackDays":0,"markOrdersAsProcessed":true,"maxConcurrentRequests":0,"orderSync":true,"productSync":true,"reconciliationSync":true,"shipBobApiUrl":"string","startShippingDate":"string","syncByDelegation":true,"syncPostalService":true,"trackingSync":true,"trackingSyncBatchSize":0},"secrets":{"integrationToken":"string","shipBobToken":"string"},"tenantName":"string"},"additionalProperties":false,"required":["secrets","config","tenantName"],"properties":{"config":{"$ref":"#/components/schemas/TriggerSync.linnworksConfig"},"secrets":{"$ref":"#/components/schemas/TriggerSync.integrationSecret"},"tenantName":{"type":"string","minLength":1}}},"TriggerSync.integrationSecret":{"type":"object","additionalProperties":false,"required":["shipBobToken","integrationToken"],"properties":{"integrationToken":{"type":"string","minLength":1},"shipBobToken":{"type":"string","minLength":1}}},"TriggerSync.integrationSuccessResponse":{"type":"object","additionalProperties":false,"properties":{"actionTaken":{"type":"integer","format":"int32","default":0,"enum":[0,1,2]},"masterSyncId":{"type":"integer","format":"int64","nullable":true},"requestId":{"type":"string","format":"uuid"}}},"TriggerSync.linnworksConfig":{"type":"object","additionalProperties":false,"required":["linnworksApiUrl","shipBobApiUrl","trackingSync","orderSync","inventorySync","productSync","lookBackDays","startShippingDate"],"properties":{"allowedHeadersForLogging":{"type":"string"},"confirmFulfillmentForProcessedOrders":{"type":"boolean"},"enableLinnworksTagCreation":{"type":"boolean"},"fcToWHMap":{"type":"array","items":{"$ref":"#/components/schemas/TriggerSync.fcToWHMapping"}},"inventorySync":{"type":"boolean"},"linnworksApiUrl":{"type":"string","minLength":1},"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":{"type":"string","minLength":1},"startShippingDate":{"type":"string","minLength":1},"syncByDelegation":{"type":"boolean"},"syncPostalService":{"type":"boolean"},"trackingSync":{"type":"boolean"},"trackingSyncBatchSize":{"type":"integer","format":"int32"}}}},"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"}}}}