{"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","operationId":"831a7380f5aaf8f77b9a356776f3e457","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Channels.v2.ChannelSearchViewModel"},"example":{"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":{"additionalProperties":false,"$ref":"#/components/schemas/Channels.Post.Api.V2.Channel.Search.Bad.Request.Object"},"example":{"property1":["string"],"property2":["string"]}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"requestBody":{"x-name":"channels.v2.ChannelsV2SearchRequest","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Channels.v2.ChannelsV2SearchRequest"}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Channels"]}},"/Experimental/receiving/:set-external-sync":{"post":{"summary":"Set ExternalSync flag for Wros\n","operationId":"a24cc704b22486f1d00776d6eabef67e","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Receiving.V2.WarehouseReceivingOrderViewModel"},"example":{"box_labels_uri":"https://api.shipbob.com/1.0/receiving/1/labels","box_packaging_type":"EverythingInOneBox","expected_arrival_date":"2019-08-24T14:15:22Z","external_sync_timestamp":"2019-08-24T14:15:22Z","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:22Z","inventory_quantities":[{"expected_quantity":0,"inventory_id":0,"received_quantity":0,"sku":"string","stowed_quantity":0}],"last_updated_date":"2019-08-24T14:15:22Z","package_type":"Package","purchase_order_number":"string","status":"Awaiting"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Receiving.Post.2.0.Receiving.Set.External.Sync.Bad.Request.Object"},"example":{"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":{"additionalProperties":false,"$ref":"#/components/schemas/Receiving.UpdateExternalSyncModel"}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Receiving"]}},"/Experimental/inventory-levels/{inventoryId}":{"get":{"summary":"    Get Inventory Levels\n","operationId":"69d1808c5d320b58f248877290e03f36","parameters":[{"name":"inventoryId","in":"path","required":true,"description":"","schema":{"type":"string","format":"int32","additionalProperties":false}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Inventory.InventoryQuantityResponse"},"example":{"inventory_id":0,"name":"string","sku":"string","total_awaiting_quantity":0,"total_backordered_quantity":0,"total_committed_quantity":0,"total_exception_quantity":0,"total_fulfillable_quantity":0,"total_internal_transfer_quantity":0,"total_on_hand_quantity":0,"total_sellable_quantity":0}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Inventory.ProblemDetails"},"example":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Inventory.ProblemDetails"},"example":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Inventory.ProblemDetails"},"example":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Inventory.ProblemDetails"},"example":{"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":["Inventories"]}},"/Experimental/inventories":{"get":{"summary":"    Get All Inventories\n","operationId":"5a3e974ce80c445f8f51b7f9ac682e2c","parameters":[{"name":"SearchBy","in":"query","description":"","schema":{"type":"string","additionalProperties":false}},{"name":"FilterOperations","in":"query","description":"","schema":{"type":"string","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Inventory.FilterOperation"}}},{"name":"InventoryIds","in":"query","description":"","schema":{"type":"string","additionalProperties":false,"items":{"type":"integer","format":"int32","additionalProperties":false}}},{"name":"IsActive","in":"query","description":"","schema":{"type":"boolean","additionalProperties":false}},{"name":"IsDigital","in":"query","description":"","schema":{"type":"boolean","additionalProperties":false}},{"name":"PageSize","in":"query","description":"","schema":{"type":"string","format":"int32","additionalProperties":false}},{"name":"SortBy","in":"query","description":"","schema":{"type":"string","additionalProperties":false}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Inventory.InventoryResponsePagedResponse"},"example":{"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":{"additionalProperties":false,"$ref":"#/components/schemas/Inventory.ProblemDetails"},"example":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Inventory.ProblemDetails"},"example":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Inventory.ProblemDetails"},"example":{"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":["Inventories"]}},"/Experimental/inventory-levels/{inventoryId}/lots":{"get":{"summary":"    Get Inventory Levels Grouped By Lot\n","operationId":"53e0fe48fd3e068eb74400fcdf4ac39d","parameters":[{"name":"inventoryId","in":"path","required":true,"description":"","schema":{"type":"string","format":"int32","additionalProperties":false}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Inventory.InventoryQuantityLotResponse"},"example":{"inventory_id":0,"lots":[{"awaiting_quantity":0,"committed_quantity":0,"fulfillable_quantity":0,"internal_transfer_quantity":0,"locations":[{"awaiting_quantity":0,"committed_quantity":0,"fulfillable_quantity":0,"internal_transfer_quantity":0,"location_id":0,"name":"string","on_hand_quantity":0}],"lot_date":"2019-08-24T14:15:22Z","lot_number":"string","on_hand_quantity":0}],"name":"string","sku":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Inventory.ProblemDetails"},"example":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Inventory.ProblemDetails"},"example":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Inventory.ProblemDetails"},"example":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Inventory.ProblemDetails"},"example":{"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":["Inventories"]}},"/Experimental/inventory-levels/lots":{"get":{"summary":"    Get All Inventory Levels Grouped By Lot\n","operationId":"f114ded633454ff81bd27c6324c5d098","parameters":[{"name":"LocationId","in":"query","description":"","schema":{"type":"string","format":"int32","additionalProperties":false}},{"name":"SearchBy","in":"query","description":"","schema":{"type":"string","additionalProperties":false}},{"name":"InventoryIds","in":"query","description":"","schema":{"type":"string","additionalProperties":false,"items":{"type":"integer","format":"int32","additionalProperties":false}}},{"name":"IsActive","in":"query","description":"","schema":{"type":"boolean","additionalProperties":false}},{"name":"IsDigital","in":"query","description":"","schema":{"type":"boolean","additionalProperties":false}},{"name":"PageSize","in":"query","description":"","schema":{"type":"string","format":"int32","additionalProperties":false}},{"name":"SortBy","in":"query","description":"","schema":{"type":"string","additionalProperties":false}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Inventory.InventoryQuantityLotResponsePagedResponse"},"example":{"first":"string","items":[{"inventory_id":0,"lots":[{"awaiting_quantity":0,"committed_quantity":0,"fulfillable_quantity":0,"internal_transfer_quantity":0,"locations":[{"awaiting_quantity":0,"committed_quantity":0,"fulfillable_quantity":0,"internal_transfer_quantity":0,"location_id":0,"name":"string","on_hand_quantity":0}],"lot_date":"2019-08-24T14:15:22Z","lot_number":"string","on_hand_quantity":0}],"name":"string","sku":"string"}],"last":"string","next":"string","prev":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Inventory.ProblemDetails"},"example":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Inventory.ProblemDetails"},"example":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Inventory.ProblemDetails"},"example":{"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":["Inventories"]}},"/Experimental/inventory-levels/{inventoryId}/locations":{"get":{"summary":"    Get Inventory Levels Grouped By Fulfillment Center\n","operationId":"9ccd2885c6a35d9758faf63aee5c50bd","parameters":[{"name":"inventoryId","in":"path","required":true,"description":"","schema":{"type":"string","format":"int32","additionalProperties":false}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Inventory.InventoryQuantityFcResponse"},"example":{"inventory_id":0,"locations":[{"awaiting_quantity":0,"committed_quantity":0,"fulfillable_quantity":0,"internal_transfer_quantity":0,"location_id":0,"name":"string","on_hand_quantity":0}],"name":"string","sku":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Inventory.ProblemDetails"},"example":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Inventory.ProblemDetails"},"example":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Inventory.ProblemDetails"},"example":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Inventory.ProblemDetails"},"example":{"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":["Inventories"]}},"/Experimental/inventories/{inventoryId}":{"get":{"summary":"    Get Inventory\n","operationId":"baabdeacd0fb29ccd774844538582e71","parameters":[{"name":"inventoryId","in":"path","required":true,"description":"","schema":{"type":"string","format":"int32","additionalProperties":false}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Inventory.InventoryResponse"},"example":{"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":{"additionalProperties":false,"$ref":"#/components/schemas/Inventory.ProblemDetails"},"example":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Inventory.ProblemDetails"},"example":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Inventory.ProblemDetails"},"example":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Inventory.ProblemDetails"},"example":{"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":["Inventories"]}},"/Experimental/inventory-levels/locations":{"get":{"summary":"    Get All Inventory Levels Grouped By Fulfillment Center\n","operationId":"511ebaa4c51b171357da1850ec73b690","parameters":[{"name":"LocationType","in":"query","description":"","schema":{"type":"string","additionalProperties":false}},{"name":"LocationId","in":"query","description":"","schema":{"type":"string","format":"int32","additionalProperties":false}},{"name":"SearchBy","in":"query","description":"","schema":{"type":"string","additionalProperties":false}},{"name":"InventoryIds","in":"query","description":"","schema":{"type":"string","additionalProperties":false,"items":{"type":"integer","format":"int32","additionalProperties":false}}},{"name":"IsActive","in":"query","description":"","schema":{"type":"boolean","additionalProperties":false}},{"name":"IsDigital","in":"query","description":"","schema":{"type":"boolean","additionalProperties":false}},{"name":"PageSize","in":"query","description":"","schema":{"type":"string","format":"int32","additionalProperties":false}},{"name":"SortBy","in":"query","description":"","schema":{"type":"string","additionalProperties":false}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Inventory.InventoryQuantityFcResponsePagedResponse"},"example":{"first":"string","items":[{"inventory_id":0,"locations":[{"awaiting_quantity":0,"committed_quantity":0,"fulfillable_quantity":0,"internal_transfer_quantity":0,"location_id":0,"name":"string","on_hand_quantity":0}],"name":"string","sku":"string"}],"last":"string","next":"string","prev":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Inventory.ProblemDetails"},"example":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Inventory.ProblemDetails"},"example":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Inventory.ProblemDetails"},"example":{"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":["Inventories"]}},"/Experimental/inventory-levels":{"get":{"summary":"    Get All Inventory Levels\n","operationId":"92f6f4de418ed836aca7dec8d17a1f84","parameters":[{"name":"SearchBy","in":"query","description":"","schema":{"type":"string","additionalProperties":false}},{"name":"InventoryIds","in":"query","description":"","schema":{"type":"string","additionalProperties":false,"items":{"type":"integer","format":"int32","additionalProperties":false}}},{"name":"IsActive","in":"query","description":"","schema":{"type":"boolean","additionalProperties":false}},{"name":"IsDigital","in":"query","description":"","schema":{"type":"boolean","additionalProperties":false}},{"name":"PageSize","in":"query","description":"","schema":{"type":"string","format":"int32","additionalProperties":false}},{"name":"SortBy","in":"query","description":"","schema":{"type":"string","additionalProperties":false}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Inventory.InventoryQuantityResponsePagedResponse"},"example":{"first":"string","items":[{"inventory_id":0,"name":"string","sku":"string","total_awaiting_quantity":0,"total_backordered_quantity":0,"total_committed_quantity":0,"total_exception_quantity":0,"total_fulfillable_quantity":0,"total_internal_transfer_quantity":0,"total_on_hand_quantity":0,"total_sellable_quantity":0}],"last":"string","next":"string","prev":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Inventory.ProblemDetails"},"example":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Inventory.ProblemDetails"},"example":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Inventory.ProblemDetails"},"example":{"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":["Inventories"]}},"/Experimental/variant/{variantId}/channel-metadata/{channelMetadataId}":{"delete":{"summary":"Used to delete a specific channel metadata record from a variant by channel metadata ID\n","operationId":"b48e74188d2b119e672f2ea93f9b96c6","parameters":[{"name":"variantId","in":"path","required":true,"description":"The ID of the variant to remove the metadata from\n","schema":{"type":"string","format":"int64","additionalProperties":false}},{"name":"channelMetadataId","in":"path","required":true,"description":"The ID of the channel metadata record to delete\n","schema":{"type":"string","format":"int64","additionalProperties":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Products.VariantViewModelV5"},"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},"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:22Z","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:22Z","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:22Z","weight":{"unit":"string","weight":0.1}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Products.Delete.Api.V5.Variant.VariantId.Channel.Metadata.ChannelMetadataId.Bad.Request.Object"},"example":{"property1":["string"],"property2":["string"]}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Products.Delete.Api.V5.Variant.VariantId.Channel.Metadata.ChannelMetadataId.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails"},"example":{"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","operationId":"90aa9021b19d7789681a49b76d79703d","parameters":[{"name":"variantId","in":"path","required":true,"description":"The ID of the variant to update the metadata from\n","schema":{"type":"string","format":"int64","additionalProperties":false}},{"name":"channelMetadataId","in":"path","required":true,"description":"The ID of the channel metadata record to update\n","schema":{"type":"string","format":"int64","additionalProperties":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Products.VariantViewModelV5"},"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},"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:22Z","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:22Z","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:22Z","weight":{"unit":"string","weight":0.1}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Products.Put.Api.V5.Variant.VariantId.Channel.Metadata.ChannelMetadataId.Bad.Request.Object"},"example":{"property1":["string"],"property2":["string"]}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Products.Put.Api.V5.Variant.VariantId.Channel.Metadata.ChannelMetadataId.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails"},"example":{"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":{"additionalProperties":false,"$ref":"#/components/schemas/Products.Put.Api.V5.Variant.VariantId.Channel.Metadata.ChannelMetadataId.Request.OneOf.AmazonChannelMetadataRequestModel.BaseChannelMetadataRequestModel.BigCommerceChannelMetadataRequestModel.ShopifyChannelMetadataRequestModel"}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Products"]}},"/Experimental/variant/{variantId}/channel-metadata":{"post":{"summary":"Create a new Channel Metadata Entry for a given Variant\n","operationId":"16bdf05dd87417fa58047a46bb481f61","parameters":[{"name":"variantId","in":"path","required":true,"description":"","schema":{"type":"string","format":"int64","additionalProperties":false}}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Products.ProductViewModelV5"},"example":{"created_on":"2019-08-24T14:15:22Z","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:22Z","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:22Z","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:22Z","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:22Z","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":{"additionalProperties":false,"$ref":"#/components/schemas/Products.Post.Api.V5.Variant.VariantId.Channel.Metadata.Request.OneOf.AmazonChannelMetadataRequestModel.BaseChannelMetadataRequestModel.BigCommerceChannelMetadataRequestModel.ShopifyChannelMetadataRequestModel"}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Products"]}},"/Experimental/product:moveVariants":{"post":{"summary":"Migrates existing variants to a new product\n","operationId":"d88155a65d5492b57f4cf1d9b2351989","responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Products.ProductViewModel"},"example":{"category":{"id":0,"name":"string"},"created_on":"2019-08-24T14:15:22Z","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:22Z","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:22Z","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:22Z","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:22Z","weight":{"unit":"string","weight":0.1}}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Products.Post.Api.V5.Product.MoveVariants.Bad.Request.Object"},"example":{"property1":["string"],"property2":["string"]}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Products.Post.Api.V5.Product.MoveVariants.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails"},"example":{"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":{"additionalProperties":false,"$ref":"#/components/schemas/Products.MigrateVariantRequestModel"}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Products"]}},"/Experimental/packaging-requirement":{"get":{"summary":"Gets Packaging Requirement\n","operationId":"672942b09322e1990e33ef572188ad73","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Products.PackagingRequirementViewModelArray"},"example":[{"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","operationId":"45c19cd89efa4b89bc9c93f3d443f77c","parameters":[{"name":"id","in":"path","required":true,"description":"","schema":{"type":"string","format":"int32","additionalProperties":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Products.TaxonomyViewModel"},"example":{"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":{"additionalProperties":false,"$ref":"#/components/schemas/Products.Get.Api.V5.Taxonomy.Id.Unauthorized.OneOf.ProblemDetails.HttpValidationProblemDetails"},"example":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Products.Get.Api.V5.Taxonomy.Id.Forbidden.OneOf.ProblemDetails.HttpValidationProblemDetails"},"example":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Products.Get.Api.V5.Taxonomy.Id.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails"},"example":{"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","operationId":"261e342a8a9514a5c30d6321ef4ff2c2","parameters":[{"name":"search","in":"query","description":"","schema":{"type":"string","additionalProperties":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Products.TaxonomyViewModelArray"},"example":[{"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":{"additionalProperties":false,"$ref":"#/components/schemas/Products.Get.Api.V5.Taxonomy.Unauthorized.OneOf.ProblemDetails.HttpValidationProblemDetails"},"example":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Products.Get.Api.V5.Taxonomy.Forbidden.OneOf.ProblemDetails.HttpValidationProblemDetails"},"example":{"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","operationId":"a3869424cb29a4540a3c8890462b4704","parameters":[{"name":"productId","in":"path","required":true,"description":"","schema":{"type":"string","format":"int64","additionalProperties":false}}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Products.ProductViewModel"},"example":{"category":{"id":0,"name":"string"},"created_on":"2019-08-24T14:15:22Z","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:22Z","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:22Z","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:22Z","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:22Z","weight":{"unit":"string","weight":0.1}}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Products.Post.Api.V5.Product.ProductId.MoveVariants.Bad.Request.Object"},"example":{"property1":["string"],"property2":["string"]}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Products.Post.Api.V5.Product.ProductId.MoveVariants.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails"},"example":{"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":{"additionalProperties":false,"$ref":"#/components/schemas/Products.MigrateVariantRequestModel"}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Products"]}},"/Experimental/variant/{variantId}:convertToBundle":{"post":{"summary":"Add new product variants to a product\n","operationId":"0386f51f54514a8488c3b7e914220aba","parameters":[{"name":"variantId","in":"path","required":true,"description":"","schema":{"type":"string","format":"int64","additionalProperties":false}}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Products.ProductViewModelV5"},"example":{"created_on":"2019-08-24T14:15:22Z","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:22Z","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:22Z","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:22Z","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:22Z","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":{"additionalProperties":false,"$ref":"#/components/schemas/Products.ConvertVariantToBundleRequest"}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Products"]}},"/Experimental/product/{productId}":{"delete":{"summary":"Deletes Bundle and removes associations to related products\n","operationId":"dff42dc941ad7015e0ef589a5df04a41","parameters":[{"name":"productId","in":"path","required":true,"description":"The product identifier\n","schema":{"type":"string","format":"int64","additionalProperties":false}}],"responses":{"200":{"description":"Success"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Products.Delete.Api.V5.Product.ProductId.Bad.Request.Object"},"example":{"property1":["string"],"property2":["string"]}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Products.Delete.Api.V5.Product.ProductId.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails"},"example":{"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","operationId":"2dd7afd0ffe30df53fe295964e471abc","parameters":[{"name":"productId","in":"path","required":true,"description":"The product identifier\n","schema":{"type":"string","format":"int64","additionalProperties":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Products.ProductViewModelV5"},"example":{"created_on":"2019-08-24T14:15:22Z","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:22Z","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:22Z","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:22Z","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:22Z","weight":{"unit":"string","weight":0.1}}]}}}}},"requestBody":{"x-name":"products.UpdateProductRequestModelV5","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Products.UpdateProductRequestModelV5"}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Products"]},"get":{"summary":"  Gets Product by Id\n","operationId":"9d82d40f4758612d28c98612ce997deb","parameters":[{"name":"productId","in":"path","required":true,"description":"","schema":{"type":"string","format":"int64","additionalProperties":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Products.ProductViewModelV5"},"example":{"created_on":"2019-08-24T14:15:22Z","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:22Z","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:22Z","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:22Z","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:22Z","weight":{"unit":"string","weight":0.1}}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Products.Get.Api.V5.Product.ProductId.Bad.Request.Object"},"example":{"property1":["string"],"property2":["string"]}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Products.Get.Api.V5.Product.ProductId.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails"},"example":{"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","operationId":"089b4461bf637cc52135f10eaf8f02a9","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","additionalProperties":false}}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Products.ProductViewModelV5"},"example":{"created_on":"2019-08-24T14:15:22Z","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:22Z","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:22Z","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:22Z","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:22Z","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":{"additionalProperties":false,"$ref":"#/components/schemas/Products.MergeVariantRequestModelArray"}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Products"]}},"/Experimental/taxonomy/{id}/parent":{"get":{"summary":"  Gets Taxonomy Parent\n","operationId":"09c013ed682b50f3d16234d4c69f519b","parameters":[{"name":"id","in":"path","required":true,"description":"","schema":{"type":"string","format":"int32","additionalProperties":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Products.TaxonomyViewModel"},"example":{"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":{"additionalProperties":false,"$ref":"#/components/schemas/Products.Get.Api.V5.Taxonomy.Id.Parent.Unauthorized.OneOf.ProblemDetails.HttpValidationProblemDetails"},"example":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Products.Get.Api.V5.Taxonomy.Id.Parent.Forbidden.OneOf.ProblemDetails.HttpValidationProblemDetails"},"example":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Products.Get.Api.V5.Taxonomy.Id.Parent.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails"},"example":{"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","operationId":"16364e8117703570686434e0b3ba7abe","parameters":[{"name":"productId","in":"path","required":true,"description":"","schema":{"type":"string","format":"int64","additionalProperties":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Products.VariantViewModelV5Array"},"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},"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:22Z","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:22Z","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:22Z","weight":{"unit":"string","weight":0.1}}]}}}},"requestBody":{"x-name":"products.UpdateProductVariantModelV5","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Products.UpdateProductVariantModelV5"}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Products"]},"get":{"summary":"Gets multiple product variants\n","operationId":"d7b5853f4a24d00f149fbe297ee11e5b","parameters":[{"name":"productId","in":"path","required":true,"description":"The product id\n","schema":{"type":"string","format":"int64","additionalProperties":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Products.VariantViewModelV5Array"},"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},"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:22Z","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:22Z","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:22Z","weight":{"unit":"string","weight":0.1}}]}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Products.Get.Api.V5.Product.ProductId.Variants.Bad.Request.Object"},"example":{"property1":["string"],"property2":["string"]}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Products.Get.Api.V5.Product.ProductId.Variants.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails"},"example":{"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","operationId":"14daa5e4386442d68fbf15d81ca67bea","parameters":[{"name":"productId","in":"path","required":true,"description":"","schema":{"type":"string","format":"int64","additionalProperties":false}}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Products.ProductViewModelV5"},"example":{"created_on":"2019-08-24T14:15:22Z","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:22Z","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:22Z","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:22Z","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:22Z","weight":{"unit":"string","weight":0.1}}]}}}}},"requestBody":{"x-name":"products.CreateProductVariantRequestModelV5Array","description":"The product variants to add to product","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Products.CreateProductVariantRequestModelV5Array"}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Products"]}},"/Experimental/product":{"get":{"summary":"Retrieves List of Products based on filters provided\n","operationId":"5e4fe606de2077dfa918ff128f5bbfff","parameters":[{"name":"Search","in":"query","description":"Search Products by name, sku, inventory id or product Id.\n","schema":{"type":"string","additionalProperties":false}},{"name":"Barcode","in":"query","description":"Barcode Associated with variant\n","schema":{"type":"string","additionalProperties":false}},{"name":"ChannelIds","in":"query","description":"Looks for Products variants by their channel IDs\n","schema":{"type":"string","additionalProperties":false,"items":{"type":"integer","additionalProperties":false}}},{"name":"HasDigitalVariants","in":"query","description":"Looks for Products with/without digital variants\n","schema":{"type":"string","additionalProperties":false}},{"name":"HasVariants","in":"query","description":"Looks for Products with/without variants\n","schema":{"type":"string","additionalProperties":false}},{"name":"InventoryId","in":"query","description":"Looks for variants by its associated inventory id\n","schema":{"type":"string","additionalProperties":false,"items":{"type":"integer","additionalProperties":false}}},{"name":"LastUpdatedTimestamp","in":"query","description":"Looks for Products that have been updated since the given date\n","schema":{"type":"string","additionalProperties":false}},{"name":"LegacyIds","in":"query","description":"Looks for Products with by Legacy Product Id(s)\n","schema":{"type":"string","additionalProperties":false,"items":{"type":"integer","additionalProperties":false}}},{"name":"Name","in":"query","description":"Looks for Products/Variants by name\n","schema":{"type":"string","additionalProperties":false}},{"name":"OnHand","in":"query","description":"Looks for Products with inventory\n","schema":{"type":"string","additionalProperties":false}},{"name":"PlatformIds","in":"query","description":"Looks for Products variants by their external Platform IDs\n","schema":{"type":"string","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},{"name":"ProductId","in":"query","description":"Looks for Products with an assigned Id\n","schema":{"type":"string","additionalProperties":false,"items":{"type":"integer","additionalProperties":false}}},{"name":"ProductType","in":"query","description":"Looks for Products by type\n","schema":{"type":"string","additionalProperties":false}},{"name":"ReviewsPending","in":"query","description":"Looks for Products by ReviewsPending\n","schema":{"type":"string","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Products.ReviewsPendingType"}}},{"name":"SalesChannel","in":"query","description":"Looks for Products variants assigned to a platform/sales channel \n","schema":{"type":"string","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},{"name":"SellerSKU","in":"query","description":"Looks for Products that match the provided Seller query\n","schema":{"type":"string","additionalProperties":false}},{"name":"SKU","in":"query","description":"Looks for Products that match the provided Sku query\n","schema":{"type":"string","additionalProperties":false}},{"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","additionalProperties":false,"items":{"type":"integer","additionalProperties":false}}},{"name":"VariantId","in":"query","description":"Looks for products that contain a variant with the given ID\n","schema":{"type":"string","additionalProperties":false,"items":{"type":"integer","additionalProperties":false}}},{"name":"VariantStatus","in":"query","description":"Looks for Products with variants that contain provided status\n","schema":{"type":"string","additionalProperties":false}},{"name":"PageSize","in":"query","description":"1-250\n","schema":{"type":"string","additionalProperties":false}},{"name":"SortBy","in":"query","description":"Id, Name, Category, TotalOnHandQty\n","schema":{"type":"string","additionalProperties":false}},{"name":"SortOrder","in":"query","description":"ASC,DESC\n","schema":{"type":"string","additionalProperties":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Products.ProductViewModelV5PagedResponse"},"example":{"first":"string","items":[{"created_on":"2019-08-24T14:15:22Z","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:22Z","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:22Z","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:22Z","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:22Z","weight":{"unit":"string","weight":0.1}}]}],"last":"string","next":"string","prev":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Products.Get.Api.V5.Product.Bad.Request.Object"},"example":{"property1":["string"],"property2":["string"]}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Products.Get.Api.V5.Product.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails"},"example":{"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","operationId":"0c4a773215d74006c7062e138ae1b94e","responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Products.ProductViewModelV5"},"example":{"created_on":"2019-08-24T14:15:22Z","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:22Z","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:22Z","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:22Z","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:22Z","weight":{"unit":"string","weight":0.1}}]}}}}},"requestBody":{"x-name":"products.CreateProductRequestModelV5","description":"The product to add","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Products.CreateProductRequestModelV5"}}}},"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","operationId":"82489ce93a8051f0db08726951ab8c5e","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","additionalProperties":false}},{"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","additionalProperties":false}},{"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","additionalProperties":false}},{"name":"invoiceTypes","in":"query","description":"[Optional] Filter invoices by invoice type. Valid values: Shipping,WarehouseStorage,Inbound Fee,Return,AdditionalFee,Credits","schema":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},{"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","additionalProperties":false}},{"name":"sortOrder","in":"query","description":"Sort invoices by Invoice Date. Values - Ascending, Descending. Default: Descending.\n","schema":{"type":"string","additionalProperties":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Billing.InvoiceDtoCursorPagedResponse"},"example":{"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":{"additionalProperties":false,"$ref":"#/components/schemas/Billing.ProblemDetails"},"example":{"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":{"additionalProperties":false,"$ref":"#/components/schemas/Billing.ProblemDetails"},"example":{"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","operationId":"67caf0689d7942353fb639b3fb23dec0","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","additionalProperties":false}},{"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","additionalProperties":false}},{"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","additionalProperties":false}},{"name":"sortOrder","in":"query","description":"Sort order of the results. Valid values: Ascending or Descending (default: Descending).\n","schema":{"type":"string","additionalProperties":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Billing.TransactionDtoCursorPagedResponse"},"example":{"first":"f8cUk/xJkbeYp2L8oHqxL2hFiGz3qjre","items":[{"additionalDetails":{"Comment":"TestInvoice"},"amount":0.09,"chargeDate":"2025-01-01","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","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":{"additionalProperties":false,"$ref":"#/components/schemas/Billing.ProblemDetails"},"example":{"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.)","operationId":"e3b509d887ccd0877c1cc2c393cb77a1","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","additionalProperties":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Billing.TransactionDtoCursorPagedResponse"},"example":{"first":"f8cUk/xJkbeYp2L8oHqxL2hFiGz3qjre","items":[{"additionalDetails":{"Comment":"TestInvoice"},"amount":0.09,"chargeDate":"2025-01-01","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","transactionType":"Charge"}],"last":"f8cUk/xJkbeYp2L8oHqxL2hFiGz3qjqt","next":"f8cUk/xjhyEYp2L8oHqxL2hFiGz3qjqt","prev":"f8cUk/xJkbeYp2L8oHqxL2hFiGz3qjcc"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Billing.ProblemDetails"},"example":{"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":{"additionalProperties":false,"$ref":"#/components/schemas/Billing.TransactionRequestFilter"}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Billing"]}},"/Experimental/transaction-fees":{"get":{"summary":"Get transaction fees\n","description":"This endpoint returns a list of transaction fees\n","operationId":"ede670103f9e3b509a817241a0821a38","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Billing.TransactionFeeModelV2"},"example":{"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"]}}},"components":{"schemas":{"Attachment.Post.Api.Attachment.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},"Attachment.Post.Api.Attachment.Unprocessable.Entity.Object":{"type":"object","additionalProperties":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},"Attachment.Post.Api.BlobKey.String":{"type":"string","additionalProperties":false},"Attachment.Post.Api.DomainType.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Attachment.Post.Api.FileName.String":{"type":"string","additionalProperties":false},"Attachment.Post.Api.FileType.Integer":{"type":"integer","format":"int32","additionalProperties":false},"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","additionalProperties":false},"AttachmentUri":{"type":"string","description":"Uri for the attachment","additionalProperties":false}}},"Billing.DateOnly":{"type":"object","additionalProperties":false,"properties":{"day":{"type":"integer","format":"int32","additionalProperties":false},"dayNumber":{"type":"integer","readOnly":true,"format":"int32","additionalProperties":false},"dayOfWeek":{"additionalProperties":false,"$ref":"#/components/schemas/Billing.DayOfWeek"},"dayOfYear":{"type":"integer","readOnly":true,"format":"int32","additionalProperties":false},"month":{"type":"integer","format":"int32","additionalProperties":false},"year":{"type":"integer","format":"int32","additionalProperties":false}}},"Billing.DayOfWeek":{"type":"integer","format":"int32","additionalProperties":false,"enum":[0,1,2,3,4,5,6]},"Billing.Get.Api.V2.Invoices.InvoiceId.Transactions.Cursor.String":{"type":"string","additionalProperties":false},"Billing.Get.Api.V2.Invoices.InvoiceId.Transactions.InvoiceId.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Billing.Get.Api.V2.Invoices.InvoiceId.Transactions.PageSize.Integer":{"type":"integer","format":"int32","default":100,"additionalProperties":false},"Billing.Get.Api.V2.TransactionV2.Invoices.Cursor.String":{"type":"string","additionalProperties":false},"Billing.Get.Api.V2.TransactionV2.Invoices.FromDate.String":{"type":"string","format":"date-time","additionalProperties":false},"Billing.Get.Api.V2.TransactionV2.Invoices.InvoiceTypes.StringArray":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}},"Billing.Get.Api.V2.TransactionV2.Invoices.PageSize.Integer":{"type":"integer","format":"int32","default":100,"additionalProperties":false},"Billing.Get.Api.V2.TransactionV2.Invoices.ToDate.String":{"type":"string","format":"date-time","additionalProperties":false},"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,"additionalProperties":false},"currencyCode":{"type":"string","description":"The ISO currency code used in the invoice (e.g., USD, EUR).","example":"USD","additionalProperties":false,"nullable":true},"invoiceDate":{"type":"string","description":"The invoice date in yyyy-mm-dd format.","example":"2025-01-01","additionalProperties":false,"nullable":true},"invoiceId":{"type":"integer","description":"Unique identifier for the invoice.","format":"int32","example":12345,"additionalProperties":false},"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","additionalProperties":false,"nullable":true},"runningBalance":{"type":"number","description":"The running balance of the account after this invoice is applied.","format":"double","example":123.01,"additionalProperties":false}}},"Billing.InvoiceDtoCursorPagedResponse":{"type":"object","additionalProperties":false,"properties":{"first":{"type":"string","description":"Go to the first page","additionalProperties":false,"nullable":true},"items":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Billing.InvoiceDto"},"nullable":true},"last":{"type":"string","description":"Go to the Last page","additionalProperties":false,"nullable":true},"next":{"type":"string","description":"Go to the Next page","additionalProperties":false,"nullable":true},"prev":{"type":"string","description":"Go to the Previous page","additionalProperties":false,"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,"additionalProperties":false},"taxRate":{"type":"number","description":"Rate of Tax charged for the tax type","format":"double","example":10,"additionalProperties":false},"taxType":{"type":"string","description":"Type of tax charged for eg. GST","example":"GST","additionalProperties":false,"nullable":true}}},"Billing.Post.Api.V2.Transactions.Query.Cursor.String":{"type":"string","additionalProperties":false},"Billing.ProblemDetails":{"type":"object","additionalProperties":{"additionalProperties":false},"properties":{"detail":{"type":"string","additionalProperties":false,"nullable":true},"instance":{"type":"string","additionalProperties":false,"nullable":true},"status":{"type":"integer","format":"int32","additionalProperties":false,"nullable":true},"title":{"type":"string","additionalProperties":false,"nullable":true},"type":{"type":"string","additionalProperties":false,"nullable":true}}},"Billing.SortOrder":{"type":"string","additionalProperties":false,"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,"additionalProperties":false,"nullable":true},"chargeDate":{"type":"string","description":"The Charge date of transaction","example":"2025-01-01","additionalProperties":false,"nullable":true},"currencyCode":{"type":"string","description":"The ISO currency code (e.g., USD, EUR) for the transaction","example":"USD","additionalProperties":false,"nullable":true},"fulfillmentCenter":{"type":"string","description":"The name or code of the fulfillment center involved in the transaction.","example":"Altona VIC","additionalProperties":false,"nullable":true},"invoiceDate":{"type":"string","description":"The date the invoice was generated","example":"2025-01-01","additionalProperties":false,"nullable":true},"invoiceId":{"type":"integer","description":"The unique identifier of the related invoice.","format":"int32","example":12345,"additionalProperties":false,"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","additionalProperties":false,"nullable":true},"invoicedStatus":{"type":"boolean","description":"Indicates whether the transaction has been invoiced.","example":true,"additionalProperties":false,"nullable":true},"referenceId":{"type":"string","description":"A unique reference identifier associated with the transaction","example":"12345","additionalProperties":false,"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","additionalProperties":false,"nullable":true},"taxes":{"type":"array","description":"A list of tax details applied to the transaction if exists.","additionalProperties":false,"items":{"additionalProperties":false,"$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","additionalProperties":false,"nullable":true},"transactionId":{"type":"string","description":"The unique identifier for transaction","example":"01AN4Z07BY79KA1307SR9X4MV3","additionalProperties":false,"nullable":true},"transactionType":{"type":"string","description":"The classification or nature of the transaction \r\nTransaction Types - Charge, Refund, Credit, Payment, BalanceAdjustment","example":"Charge","additionalProperties":false,"nullable":true}}},"Billing.TransactionDtoCursorPagedResponse":{"type":"object","additionalProperties":false,"properties":{"first":{"type":"string","description":"Go to the first page","additionalProperties":false,"nullable":true},"items":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Billing.TransactionDto"},"nullable":true},"last":{"type":"string","description":"Go to the Last page","additionalProperties":false,"nullable":true},"next":{"type":"string","description":"Go to the Next page","additionalProperties":false,"nullable":true},"prev":{"type":"string","description":"Go to the Previous page","additionalProperties":false,"nullable":true}}},"Billing.TransactionFeeModelV2":{"type":"object","additionalProperties":false,"properties":{"feeList":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false},"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","additionalProperties":false,"nullable":true},"invoiceIds":{"type":"array","description":"List of invoice IDs to filter transactions","additionalProperties":false,"items":{"type":"string","additionalProperties":false},"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)","additionalProperties":false,"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","additionalProperties":false},"referenceIds":{"type":"array","description":"List of reference IDs (like Shipment ID, WRO id) to filter transactions (can be numeric or string identifiers).","additionalProperties":false,"items":{"type":"string","additionalProperties":false},"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","additionalProperties":false,"items":{"type":"string","additionalProperties":false},"nullable":true},"sortOrder":{"additionalProperties":false,"$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","additionalProperties":false,"nullable":true},"transactionFees":{"type":"array","description":"To get all the available transaction fees use this endpoint:- '/transaction-fees'","additionalProperties":false,"items":{"type":"string","additionalProperties":false},"nullable":true},"transactionTypes":{"type":"array","description":"The classification or nature of the transaction \r\nTransaction Types - Charge, Refund, Credit, Payment, BalanceAdjustment","additionalProperties":false,"items":{"type":"string","additionalProperties":false},"nullable":true}}},"Channels.ChannelViewModel":{"type":"object","additionalProperties":false,"properties":{"application_name":{"type":"string","description":"Name of the application that owns the channel","example":"Api","additionalProperties":false,"nullable":true},"id":{"type":"integer","description":"Unique id of the channel","format":"int32","additionalProperties":false},"name":{"type":"string","description":"Name of the channel","additionalProperties":false,"nullable":true},"scopes":{"type":"array","description":"Array of permissions granted for the channel","example":["channels_read","orders_read","orders_write"],"additionalProperties":false,"items":{"type":"string","additionalProperties":false},"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,"additionalProperties":false}}},"Channels.Post.Api.V2.Channel.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},"Channels.Post.Api.V2.Channel.InheritScopes.Boolean":{"type":"boolean","default":false,"additionalProperties":false},"Channels.Post.Api.V2.Channel.Search.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},"Channels.v2.ChannelBasicViewModel":{"type":"object","description":"Channel basic information","additionalProperties":false,"properties":{"id":{"type":"integer","description":"","format":"int32","additionalProperties":false},"name":{"type":"string","description":"","additionalProperties":false,"nullable":true}}},"Channels.v2.ChannelSearchViewModel":{"type":"object","description":"GChannel search response","additionalProperties":false,"properties":{"items":{"type":"array","description":"List of channels","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Channels.v2.ChannelBasicViewModel"},"nullable":true},"next":{"type":"string","description":"Next page cursor","additionalProperties":false,"nullable":true},"prev":{"type":"string","description":"Previous page cursor","additionalProperties":false,"nullable":true},"total_records":{"type":"integer","description":"Total records on current page","format":"int32","additionalProperties":false}}},"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","additionalProperties":false,"nullable":true},"records_per_page":{"type":"integer","description":"Records Per Page","format":"int32","additionalProperties":false},"search_filters":{"additionalProperties":false,"$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","additionalProperties":false,"items":{"type":"integer","format":"int32","additionalProperties":false},"nullable":true},"channel_names":{"type":"array","description":"Channel Names to search for","additionalProperties":false,"items":{"type":"string","additionalProperties":false},"nullable":true}}},"FacilityWorkflowIntegrations.CreateInventoryLotExclusionBody":{"type":"object","description":"Request body for creating an inventory lot exclusion.","example":{"inventoryId":0,"lotDate":"2024-01-01T00:00:00Z","lotNumber":"string"},"additionalProperties":false,"required":["inventoryId"],"properties":{"inventoryId":{"type":"integer","description":"The unique identifier for the inventory item.","format":"int32","additionalProperties":false},"lotDate":{"type":"string","description":"The lot date to exclude.","format":"date-time","additionalProperties":false,"nullable":true},"lotNumber":{"type":"string","description":"The lot number to exclude.","additionalProperties":false,"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.","additionalProperties":false},"failureReason":{"type":"integer","description":"Reason for failure if not created.","format":"int32","additionalProperties":false},"item":{"type":"object","additionalProperties":false,"properties":{"createdTimestamp":{"type":"string","format":"date-time","additionalProperties":false},"deletedTimestamp":{"type":"string","format":"date-time","additionalProperties":false,"nullable":true},"id":{"type":"integer","format":"int32","additionalProperties":false},"inventoryId":{"type":"integer","format":"int32","additionalProperties":false},"isDeleted":{"type":"boolean","additionalProperties":false},"lotDate":{"type":"string","format":"date-time","additionalProperties":false,"nullable":true},"lotNumber":{"type":"string","additionalProperties":false,"nullable":true},"userId":{"type":"integer","format":"int32","additionalProperties":false}},"nullable":true},"message":{"type":"string","description":"Message describing the result.","additionalProperties":false,"nullable":true}}},"FacilityWorkflowIntegrations.LotExclusionMutationBody":{"type":"object","description":"Request body for mutating (deleting or restoring) an inventory lot exclusion.","example":{"id":0},"additionalProperties":false,"required":["id"],"properties":{"id":{"type":"integer","description":"The unique identifier for the inventory lot exclusion.","format":"int32","additionalProperties":false}}},"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","additionalProperties":false,"nullable":true},"failureReason":{"type":"integer","description":"Reason for failure if not successful.","format":"int32","additionalProperties":false},"isDeleted":{"type":"boolean","description":"Current deletion status of the lot exclusion.","additionalProperties":false},"message":{"type":"string","description":"Message describing the result.","additionalProperties":false,"nullable":true},"success":{"type":"boolean","description":"Indicates whether the mutation was successful.","additionalProperties":false}}},"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","additionalProperties":false},"inventorySku":{"type":"string","description":"An identifier for a particular piece of inventory.","additionalProperties":false,"nullable":true},"quantityToPick":{"type":"integer","description":"The quantity to be picked.","format":"int32","additionalProperties":false},"transactionId":{"type":"string","description":"The unique identifier for a transaction.","additionalProperties":false,"nullable":true}}},"FacilityWorkflowIntegrations.ShopifyResponseError":{"type":"object","additionalProperties":false,"properties":{"errorMessage":{"type":"string","additionalProperties":false,"nullable":true}}},"FulfillmentCenterInventoryService.Get.Inventory.InventoryId.History.Cursor.Integer":{"type":"integer","format":"int32","additionalProperties":false},"FulfillmentCenterInventoryService.Get.Inventory.InventoryId.History.EndDate.String":{"type":"string","format":"date-time","additionalProperties":false},"FulfillmentCenterInventoryService.Get.Inventory.InventoryId.History.EventCategory.String":{"type":"string","additionalProperties":false},"FulfillmentCenterInventoryService.Get.Inventory.InventoryId.History.FacilityId.Integer":{"type":"integer","format":"int32","additionalProperties":false},"FulfillmentCenterInventoryService.Get.Inventory.InventoryId.History.InventoryId.Integer":{"type":"integer","format":"int32","additionalProperties":false},"FulfillmentCenterInventoryService.Get.Inventory.InventoryId.History.StartDate.String":{"type":"string","format":"date-time","additionalProperties":false},"FulfillmentCenterInventoryService.InventoryHistory":{"type":"object","additionalProperties":false,"properties":{"additional_reference":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/FulfillmentCenterInventoryService.InventoryHistoryAdditionalReference"},"nullable":true},"decrement":{"additionalProperties":false,"$ref":"#/components/schemas/FulfillmentCenterInventoryService.InventoryHistoryDetails"},"event_category":{"type":"string","additionalProperties":false,"nullable":true},"event_datetime":{"type":"string","format":"date-time","additionalProperties":false},"increment":{"additionalProperties":false,"$ref":"#/components/schemas/FulfillmentCenterInventoryService.InventoryHistoryDetails"},"inventory_audit_event_id":{"type":"integer","format":"int32","additionalProperties":false},"inventory_id":{"type":"integer","format":"int32","additionalProperties":false},"merchant_user_id":{"type":"integer","format":"int32","additionalProperties":false,"nullable":true},"shipbob_order_id":{"type":"integer","format":"int32","additionalProperties":false,"nullable":true}}},"FulfillmentCenterInventoryService.InventoryHistoryAdditionalReference":{"type":"object","additionalProperties":false,"properties":{"key":{"type":"string","additionalProperties":false,"nullable":true},"value":{"type":"string","additionalProperties":false,"nullable":true}}},"FulfillmentCenterInventoryService.InventoryHistoryDetails":{"type":"object","additionalProperties":false,"properties":{"committed_quantity_change":{"type":"integer","format":"int32","additionalProperties":false},"expiration_date":{"type":"string","format":"date-time","additionalProperties":false,"nullable":true},"facility_id":{"type":"integer","format":"int32","additionalProperties":false},"inventory_status":{"type":"string","additionalProperties":false,"nullable":true},"location_id":{"type":"integer","format":"int32","additionalProperties":false},"lot_number":{"type":"string","additionalProperties":false,"nullable":true},"operational_stage":{"additionalProperties":false,"$ref":"#/components/schemas/FulfillmentCenterInventoryService.YukiOperationalStageEnumTypeResponse"},"pack_description_id":{"additionalProperties":false,"$ref":"#/components/schemas/FulfillmentCenterInventoryService.Ulid"},"quantity_change":{"type":"integer","format":"int32","additionalProperties":false},"sku":{"type":"string","additionalProperties":false,"nullable":true},"yuki_id":{"additionalProperties":false,"$ref":"#/components/schemas/FulfillmentCenterInventoryService.Ulid"}}},"FulfillmentCenterInventoryService.InventoryHistoryResponse":{"type":"object","additionalProperties":false,"properties":{"data":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/FulfillmentCenterInventoryService.InventoryHistory"},"nullable":true},"first":{"type":"string","additionalProperties":false,"nullable":true},"last":{"type":"string","additionalProperties":false,"nullable":true},"next":{"type":"string","additionalProperties":false,"nullable":true},"prev":{"type":"string","additionalProperties":false,"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","additionalProperties":false,"nullable":true},"end_date":{"type":"string","format":"date-time","additionalProperties":false,"nullable":true},"event_category":{"type":"string","additionalProperties":false,"nullable":true},"facility_id":{"type":"integer","format":"int32","additionalProperties":false},"inventory_ids":{"type":"array","additionalProperties":false,"items":{"type":"integer","format":"int32","additionalProperties":false},"nullable":true},"merchant_user_id":{"type":"integer","format":"int32","additionalProperties":false,"nullable":true},"start_date":{"type":"string","format":"date-time","additionalProperties":false,"nullable":true}}},"FulfillmentCenterInventoryService.Post.Inventory.History.Query.Cursor.Integer":{"type":"integer","format":"int32","additionalProperties":false},"FulfillmentCenterInventoryService.Ulid":{"type":"object","additionalProperties":false,"properties":{"random":{"type":"string","readOnly":true,"format":"byte","additionalProperties":false,"nullable":true},"time":{"type":"string","readOnly":true,"format":"date-time","additionalProperties":false}}},"FulfillmentCenterInventoryService.YukiOperationalStageEnumTypeResponse":{"type":"object","additionalProperties":false,"properties":{"description":{"type":"string","readOnly":true,"additionalProperties":false,"nullable":true},"id":{"type":"integer","readOnly":true,"format":"int32","additionalProperties":false}}},"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","additionalProperties":false},"inventory_id":{"type":"integer","format":"int32","additionalProperties":false},"lot_number":{"type":"string","additionalProperties":false,"nullable":true}}},"Inventory.DimensionsResponse":{"type":"object","additionalProperties":false,"properties":{"height":{"type":"number","format":"double","additionalProperties":false},"is_locked":{"type":"boolean","additionalProperties":false},"length":{"type":"number","format":"double","additionalProperties":false},"unit":{"type":"string","additionalProperties":false,"nullable":true},"validated":{"type":"boolean","additionalProperties":false},"width":{"type":"number","format":"double","additionalProperties":false}}},"Inventory.FilterOperati":{"type":"object","additionalProperties":false,"properties":{"key":{"type":"string","additionalProperties":false,"nullable":true},"rawValue":{"type":"string","additionalProperties":false,"nullable":true}}},"Inventory.FilterOperation":{"type":"object","additionalProperties":false,"properties":{"key":{"type":"string","additionalProperties":false,"nullable":true},"rawValue":{"type":"string","additionalProperties":false,"nullable":true}}},"Inventory.FilterOperationArray":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Inventory.FilterOperation"}},"Inventory.FulfillableQuantityByFulfillmentCenter":{"type":"object","additionalProperties":false,"properties":{"awaiting_quantity":{"type":"integer","format":"int32","additionalProperties":false},"committed_quantity":{"type":"integer","format":"int32","additionalProperties":false},"fulfillable_quantity":{"type":"integer","format":"int32","additionalProperties":false},"internal_transfer_quantity":{"type":"integer","format":"int32","additionalProperties":false},"location_id":{"type":"integer","format":"int32","additionalProperties":false},"name":{"type":"string","additionalProperties":false,"nullable":true},"on_hand_quantity":{"type":"integer","format":"int32","additionalProperties":false}}},"Inventory.FulfillmentCenterResponse":{"type":"object","additionalProperties":false,"properties":{"awaiting_quantity":{"type":"integer","format":"int32","additionalProperties":false},"committed_quantity":{"type":"integer","format":"int32","additionalProperties":false},"fulfillable_quantity":{"type":"integer","format":"int32","additionalProperties":false},"internal_transfer_quantity":{"type":"integer","format":"int32","additionalProperties":false},"location_id":{"type":"integer","format":"int32","additionalProperties":false},"name":{"type":"string","additionalProperties":false,"nullable":true},"on_hand_quantity":{"type":"integer","format":"int32","additionalProperties":false}}},"Inventory.Get.Api.V2.Inventories.InventoryId.InventoryId.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Inventory.Get.Api.V2.Inventories.InventoryIds.IntegerArray":{"type":"array","additionalProperties":false,"items":{"type":"integer","format":"int32","additionalProperties":false}},"Inventory.Get.Api.V2.Inventories.IsActive.Boolea":{"type":"boolean","additionalProperties":false},"Inventory.Get.Api.V2.Inventories.IsActive.Boolean":{"type":"boolean","additionalProperties":false},"Inventory.Get.Api.V2.Inventories.IsDigital.Boolea":{"type":"boolean","additionalProperties":false},"Inventory.Get.Api.V2.Inventories.IsDigital.Boolean":{"type":"boolean","additionalProperties":false},"Inventory.Get.Api.V2.Inventories.PageSize.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Inventory.Get.Api.V2.Inventories.SearchBy.String":{"type":"string","additionalProperties":false},"Inventory.Get.Api.V2.Inventories.SortBy.String":{"type":"string","additionalProperties":false},"Inventory.Get.Api.V2.Inventory.Levels.InventoryId.InventoryId.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Inventory.Get.Api.V2.Inventory.Levels.InventoryId.Locations.InventoryId.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Inventory.Get.Api.V2.Inventory.Levels.InventoryId.Lots.InventoryId.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Inventory.Get.Api.V2.Inventory.Levels.InventoryIds.IntegerArray":{"type":"array","additionalProperties":false,"items":{"type":"integer","format":"int32","additionalProperties":false}},"Inventory.Get.Api.V2.Inventory.Levels.IsActive.Boolea":{"type":"boolean","additionalProperties":false},"Inventory.Get.Api.V2.Inventory.Levels.IsActive.Boolean":{"type":"boolean","additionalProperties":false},"Inventory.Get.Api.V2.Inventory.Levels.IsDigital.Boolea":{"type":"boolean","additionalProperties":false},"Inventory.Get.Api.V2.Inventory.Levels.IsDigital.Boolean":{"type":"boolean","additionalProperties":false},"Inventory.Get.Api.V2.Inventory.Levels.Locations.InventoryIds.IntegerArray":{"type":"array","additionalProperties":false,"items":{"type":"integer","format":"int32","additionalProperties":false}},"Inventory.Get.Api.V2.Inventory.Levels.Locations.IsActive.Boolea":{"type":"boolean","additionalProperties":false},"Inventory.Get.Api.V2.Inventory.Levels.Locations.IsActive.Boolean":{"type":"boolean","additionalProperties":false},"Inventory.Get.Api.V2.Inventory.Levels.Locations.IsDigital.Boolea":{"type":"boolean","additionalProperties":false},"Inventory.Get.Api.V2.Inventory.Levels.Locations.IsDigital.Boolean":{"type":"boolean","additionalProperties":false},"Inventory.Get.Api.V2.Inventory.Levels.Locations.LocationId.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Inventory.Get.Api.V2.Inventory.Levels.Locations.LocationType.String":{"type":"string","additionalProperties":false},"Inventory.Get.Api.V2.Inventory.Levels.Locations.PageSize.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Inventory.Get.Api.V2.Inventory.Levels.Locations.SearchBy.String":{"type":"string","additionalProperties":false},"Inventory.Get.Api.V2.Inventory.Levels.Locations.SortBy.String":{"type":"string","additionalProperties":false},"Inventory.Get.Api.V2.Inventory.Levels.Lots.InventoryIds.IntegerArray":{"type":"array","additionalProperties":false,"items":{"type":"integer","format":"int32","additionalProperties":false}},"Inventory.Get.Api.V2.Inventory.Levels.Lots.IsActive.Boolea":{"type":"boolean","additionalProperties":false},"Inventory.Get.Api.V2.Inventory.Levels.Lots.IsActive.Boolean":{"type":"boolean","additionalProperties":false},"Inventory.Get.Api.V2.Inventory.Levels.Lots.IsDigital.Boolea":{"type":"boolean","additionalProperties":false},"Inventory.Get.Api.V2.Inventory.Levels.Lots.IsDigital.Boolean":{"type":"boolean","additionalProperties":false},"Inventory.Get.Api.V2.Inventory.Levels.Lots.LocationId.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Inventory.Get.Api.V2.Inventory.Levels.Lots.PageSize.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Inventory.Get.Api.V2.Inventory.Levels.Lots.SearchBy.String":{"type":"string","additionalProperties":false},"Inventory.Get.Api.V2.Inventory.Levels.Lots.SortBy.String":{"type":"string","additionalProperties":false},"Inventory.Get.Api.V2.Inventory.Levels.PageSize.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Inventory.Get.Api.V2.Inventory.Levels.SearchBy.String":{"type":"string","additionalProperties":false},"Inventory.Get.Api.V2.Inventory.Levels.SortBy.String":{"type":"string","additionalProperties":false},"Inventory.Get.Api.V3.Inventories.InventoryId.InventoryId.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Inventory.Get.Api.V3.Inventories.InventoryIds.IntegerArray":{"type":"array","additionalProperties":false,"items":{"type":"integer","format":"int32","additionalProperties":false}},"Inventory.Get.Api.V3.Inventories.IsActive.Boolean":{"type":"boolean","additionalProperties":false},"Inventory.Get.Api.V3.Inventories.IsDigital.Boolean":{"type":"boolean","additionalProperties":false},"Inventory.Get.Api.V3.Inventories.PageSize.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Inventory.Get.Api.V3.Inventories.SearchBy.String":{"type":"string","additionalProperties":false},"Inventory.Get.Api.V3.Inventories.SortBy.String":{"type":"string","additionalProperties":false},"Inventory.Get.Api.V3.Inventory.Levels.InventoryId.InventoryId.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Inventory.Get.Api.V3.Inventory.Levels.InventoryId.Locations.InventoryId.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Inventory.Get.Api.V3.Inventory.Levels.InventoryId.Lots.InventoryId.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Inventory.Get.Api.V3.Inventory.Levels.InventoryIds.IntegerArray":{"type":"array","additionalProperties":false,"items":{"type":"integer","format":"int32","additionalProperties":false}},"Inventory.Get.Api.V3.Inventory.Levels.IsActive.Boolean":{"type":"boolean","additionalProperties":false},"Inventory.Get.Api.V3.Inventory.Levels.IsDigital.Boolean":{"type":"boolean","additionalProperties":false},"Inventory.Get.Api.V3.Inventory.Levels.Locations.InventoryIds.IntegerArray":{"type":"array","additionalProperties":false,"items":{"type":"integer","format":"int32","additionalProperties":false}},"Inventory.Get.Api.V3.Inventory.Levels.Locations.IsActive.Boolean":{"type":"boolean","additionalProperties":false},"Inventory.Get.Api.V3.Inventory.Levels.Locations.IsDigital.Boolean":{"type":"boolean","additionalProperties":false},"Inventory.Get.Api.V3.Inventory.Levels.Locations.LocationId.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Inventory.Get.Api.V3.Inventory.Levels.Locations.LocationType.String":{"type":"string","additionalProperties":false},"Inventory.Get.Api.V3.Inventory.Levels.Locations.PageSize.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Inventory.Get.Api.V3.Inventory.Levels.Locations.SearchBy.String":{"type":"string","additionalProperties":false},"Inventory.Get.Api.V3.Inventory.Levels.Locations.SortBy.String":{"type":"string","additionalProperties":false},"Inventory.Get.Api.V3.Inventory.Levels.Lots.InventoryIds.IntegerArray":{"type":"array","additionalProperties":false,"items":{"type":"integer","format":"int32","additionalProperties":false}},"Inventory.Get.Api.V3.Inventory.Levels.Lots.IsActive.Boolean":{"type":"boolean","additionalProperties":false},"Inventory.Get.Api.V3.Inventory.Levels.Lots.IsDigital.Boolean":{"type":"boolean","additionalProperties":false},"Inventory.Get.Api.V3.Inventory.Levels.Lots.LocationId.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Inventory.Get.Api.V3.Inventory.Levels.Lots.PageSize.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Inventory.Get.Api.V3.Inventory.Levels.Lots.SearchBy.String":{"type":"string","additionalProperties":false},"Inventory.Get.Api.V3.Inventory.Levels.Lots.SortBy.String":{"type":"string","additionalProperties":false},"Inventory.Get.Api.V3.Inventory.Levels.PageSize.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Inventory.Get.Api.V3.Inventory.Levels.SearchBy.String":{"type":"string","additionalProperties":false},"Inventory.Get.Api.V3.Inventory.Levels.SortBy.String":{"type":"string","additionalProperties":false},"Inventory.HazmatResponse":{"type":"object","additionalProperties":false,"properties":{"is_hazmat":{"type":"boolean","additionalProperties":false},"validated":{"type":"boolean","additionalProperties":false}}},"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","additionalProperties":false},"fulfillmentCenterId":{"type":"integer","description":"Fulfillment center Id to filter by.","format":"int32","additionalProperties":false},"inventoryIds":{"type":"array","description":"List of InventoryIds to filter by.","additionalProperties":false,"items":{"type":"integer","format":"int32","additionalProperties":false},"nullable":true},"requestId":{"type":"string","description":"RequestId to correlate the request with the response file","additionalProperties":false,"nullable":true},"startDate":{"type":"string","description":"Start date to filter orders inserted later than.","format":"date-time","additionalProperties":false}}},"Inventory.InventoryHistoryReportResponse":{"type":"object","additionalProperties":false,"properties":{"reportUrl":{"type":"string","description":"The publicly accessible URL to download the report","additionalProperties":false,"nullable":true},"requestId":{"type":"string","description":"RequestId to correlate the request with the response file","additionalProperties":false,"nullable":true}}},"Inventory.InventoryQuantityFcResponse":{"type":"object","additionalProperties":false,"properties":{"inventory_id":{"type":"integer","format":"int32","additionalProperties":false},"locations":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Inventory.FulfillmentCenterResponse"},"nullable":true},"name":{"type":"string","additionalProperties":false,"nullable":true},"sku":{"type":"string","additionalProperties":false,"nullable":true}}},"Inventory.InventoryQuantityFcResponsePagedResponse":{"type":"object","additionalProperties":false,"properties":{"first":{"type":"string","additionalProperties":false,"nullable":true},"items":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Inventory.InventoryQuantityFcResponse"},"nullable":true},"last":{"type":"string","additionalProperties":false,"nullable":true},"next":{"type":"string","additionalProperties":false,"nullable":true},"prev":{"type":"string","additionalProperties":false,"nullable":true}}},"Inventory.InventoryQuantityLotResponse":{"type":"object","additionalProperties":false,"properties":{"inventory_id":{"type":"integer","format":"int32","additionalProperties":false},"lots":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Inventory.Lots"},"nullable":true},"name":{"type":"string","additionalProperties":false,"nullable":true},"sku":{"type":"string","additionalProperties":false,"nullable":true}}},"Inventory.InventoryQuantityLotResponsePagedResponse":{"type":"object","additionalProperties":false,"properties":{"first":{"type":"string","additionalProperties":false,"nullable":true},"items":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Inventory.InventoryQuantityLotResponse"},"nullable":true},"last":{"type":"string","additionalProperties":false,"nullable":true},"next":{"type":"string","additionalProperties":false,"nullable":true},"prev":{"type":"string","additionalProperties":false,"nullable":true}}},"Inventory.InventoryQuantityResponse":{"type":"object","additionalProperties":false,"properties":{"inventory_id":{"type":"integer","format":"int32","additionalProperties":false},"name":{"type":"string","additionalProperties":false,"nullable":true},"sku":{"type":"string","additionalProperties":false,"nullable":true},"total_awaiting_quantity":{"type":"integer","format":"int32","additionalProperties":false},"total_backordered_quantity":{"type":"integer","format":"int32","additionalProperties":false},"total_committed_quantity":{"type":"integer","format":"int32","additionalProperties":false},"total_exception_quantity":{"type":"integer","format":"int32","additionalProperties":false},"total_fulfillable_quantity":{"type":"integer","format":"int32","additionalProperties":false},"total_internal_transfer_quantity":{"type":"integer","format":"int32","additionalProperties":false},"total_on_hand_quantity":{"type":"integer","format":"int32","additionalProperties":false},"total_sellable_quantity":{"type":"integer","format":"int32","additionalProperties":false}}},"Inventory.InventoryQuantityResponsePagedResponse":{"type":"object","additionalProperties":false,"properties":{"first":{"type":"string","additionalProperties":false,"nullable":true},"items":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Inventory.InventoryQuantityResponse"},"nullable":true},"last":{"type":"string","additionalProperties":false,"nullable":true},"next":{"type":"string","additionalProperties":false,"nullable":true},"prev":{"type":"string","additionalProperties":false,"nullable":true}}},"Inventory.InventoryResponse":{"type":"object","additionalProperties":false,"properties":{"barcode":{"type":"string","additionalProperties":false,"nullable":true},"dimensions":{"additionalProperties":false,"$ref":"#/components/schemas/Inventory.DimensionsResponse"},"inventory_id":{"type":"integer","format":"int32","additionalProperties":false},"is_case":{"type":"boolean","additionalProperties":false},"is_lot":{"type":"boolean","additionalProperties":false},"name":{"type":"string","additionalProperties":false,"nullable":true},"sku":{"type":"string","additionalProperties":false,"nullable":true},"user_id":{"type":"integer","format":"int32","additionalProperties":false},"variant":{"additionalProperties":false,"$ref":"#/components/schemas/Inventory.VariantResponse"},"weight":{"additionalProperties":false,"$ref":"#/components/schemas/Inventory.WeightResponse"}}},"Inventory.InventoryResponsePagedResponse":{"type":"object","additionalProperties":false,"properties":{"first":{"type":"string","additionalProperties":false,"nullable":true},"items":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Inventory.InventoryResponse"},"nullable":true},"last":{"type":"string","additionalProperties":false,"nullable":true},"next":{"type":"string","additionalProperties":false,"nullable":true},"prev":{"type":"string","additionalProperties":false,"nullable":true}}},"Inventory.Lot":{"type":"object","additionalProperties":false,"properties":{"awaiting_quantity":{"type":"integer","format":"int32","additionalProperties":false},"committed_quantity":{"type":"integer","format":"int32","additionalProperties":false},"fulfillable_quantity":{"type":"integer","format":"int32","additionalProperties":false},"internal_transfer_quantity":{"type":"integer","format":"int32","additionalProperties":false},"locations":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Inventory.FulfillableQuantityByFulfillmentCenter"},"nullable":true},"lot_date":{"type":"string","format":"date-time","additionalProperties":false,"nullable":true},"lot_number":{"type":"string","additionalProperties":false,"nullable":true},"on_hand_quantity":{"type":"integer","format":"int32","additionalProperties":false}}},"Inventory.Lots":{"type":"object","additionalProperties":false,"properties":{"awaiting_quantity":{"type":"integer","format":"int32","additionalProperties":false},"committed_quantity":{"type":"integer","format":"int32","additionalProperties":false},"fulfillable_quantity":{"type":"integer","format":"int32","additionalProperties":false},"internal_transfer_quantity":{"type":"integer","format":"int32","additionalProperties":false},"locations":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Inventory.FulfillableQuantityByFulfillmentCenter"},"nullable":true},"lot_date":{"type":"string","format":"date-time","additionalProperties":false,"nullable":true},"lot_number":{"type":"string","additionalProperties":false,"nullable":true},"on_hand_quantity":{"type":"integer","format":"int32","additionalProperties":false}}},"Inventory.Post.Api.Inventory.History.Report.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},"Inventory.ProblemDetail":{"type":"object","additionalProperties":{"additionalProperties":false},"properties":{"detail":{"type":"string","additionalProperties":false,"nullable":true},"instance":{"type":"string","additionalProperties":false,"nullable":true},"status":{"type":"integer","format":"int32","additionalProperties":false,"nullable":true},"title":{"type":"string","additionalProperties":false,"nullable":true},"type":{"type":"string","additionalProperties":false,"nullable":true}}},"Inventory.ProblemDetails":{"type":"object","additionalProperties":{"additionalProperties":false},"properties":{"detail":{"type":"string","additionalProperties":false,"nullable":true},"instance":{"type":"string","additionalProperties":false,"nullable":true},"status":{"type":"integer","format":"int32","additionalProperties":false,"nullable":true},"title":{"type":"string","additionalProperties":false,"nullable":true},"type":{"type":"string","additionalProperties":false,"nullable":true}}},"Inventory.ResponseError":{"type":"object","additionalProperties":false,"properties":{"error_message":{"type":"string","additionalProperties":false,"nullable":true}}},"Inventory.VariantResponse":{"type":"object","additionalProperties":false,"properties":{"hazmat":{"additionalProperties":false,"$ref":"#/components/schemas/Inventory.HazmatResponse"},"is_active":{"type":"boolean","additionalProperties":false},"is_bundle":{"type":"boolean","additionalProperties":false},"is_digital":{"type":"boolean","additionalProperties":false}}},"Inventory.WeightResponse":{"type":"object","additionalProperties":false,"properties":{"unit":{"type":"string","additionalProperties":false,"nullable":true},"value":{"type":"number","format":"double","additionalProperties":false}}},"Logistics.Get.Api.Batch.Batch.Id.Batch.Id.String":{"type":"string","additionalProperties":false},"Logistics.Get.Api.Batch.Batch.Id.OK.Object":{"type":"object","additionalProperties":false,"properties":{"_created_at":{"type":"string","format":"date-time","additionalProperties":false},"batch_id":{"type":"string","additionalProperties":false},"batch_number":{"type":"integer","additionalProperties":false},"count":{"type":"integer","additionalProperties":false},"orders":{"type":"array","additionalProperties":false,"items":{"type":"object","additionalProperties":false,"properties":{"_id":{"type":"string","additionalProperties":false},"dimensions_present_in_sb":{"type":"boolean","additionalProperties":false},"label_printed":{"type":"boolean","additionalProperties":false},"merchant_id":{"type":"string","additionalProperties":false},"meta":{"type":"object","additionalProperties":false,"properties":{"customer_name":{"type":"string","additionalProperties":false},"order_id":{"type":"string","additionalProperties":false},"order_number":{"type":"string","additionalProperties":false}}},"order":{"type":"object","additionalProperties":false,"properties":{"location_id":{"type":"integer","additionalProperties":false},"measurements":{"type":"object","additionalProperties":false,"properties":{"depth_in":{"type":"number","additionalProperties":false},"length_in":{"type":"number","additionalProperties":false},"total_weight_oz":{"type":"number","additionalProperties":false},"width_in":{"type":"number","additionalProperties":false}}},"products":{"type":"array","additionalProperties":false,"items":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","additionalProperties":false},"quantity":{"type":"integer","additionalProperties":false},"sku":{"type":"string","additionalProperties":false}}}},"recipient":{"type":"object","additionalProperties":false,"properties":{"address":{"type":"object","additionalProperties":false,"properties":{"address1":{"type":"string","additionalProperties":false},"address2":{"type":"string","additionalProperties":false},"city":{"type":"string","additionalProperties":false},"country":{"type":"string","additionalProperties":false},"state":{"type":"string","additionalProperties":false},"zip_code":{"type":"string","additionalProperties":false}}},"name":{"type":"string","additionalProperties":false}}},"reference_id":{"type":"string","additionalProperties":false},"shipping_method":{"type":"string","additionalProperties":false}}},"sb_created":{"type":"boolean","additionalProperties":false},"sb_created_At":{"type":"string","format":"date-time","additionalProperties":false},"shipment_id":{"type":"integer","additionalProperties":false}}}},"products":{"type":"array","additionalProperties":false,"items":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","additionalProperties":false},"quantity":{"type":"integer","additionalProperties":false},"sku":{"type":"string","additionalProperties":false}}}}}},"Logistics.Get.Api.Batches.Batch.Printed.Boolean":{"type":"boolean","additionalProperties":false},"Logistics.Get.Api.Batches.OK.Object":{"type":"object","additionalProperties":false,"properties":{"batches":{"type":"array","additionalProperties":false,"items":{"type":"object","additionalProperties":false,"properties":{"_created_at":{"type":"string","format":"date-time","additionalProperties":false},"_id":{"type":"string","additionalProperties":false},"_updated_at":{"type":"string","format":"date-time","additionalProperties":false},"batch_number":{"type":"integer","additionalProperties":false},"merchant_id":{"type":"string","additionalProperties":false},"number_of_orders":{"type":"integer","additionalProperties":false},"products":{"type":"array","additionalProperties":false,"items":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","additionalProperties":false},"quantity":{"type":"integer","additionalProperties":false},"sku":{"type":"string","additionalProperties":false}}}},"products_hash":{"type":"string","additionalProperties":false},"shipment_ids":{"type":"array","additionalProperties":false,"items":{"type":"integer","additionalProperties":false}}}}},"count":{"type":"integer","additionalProperties":false},"last_refreshed_at":{"type":"string","format":"date-time","additionalProperties":false}}},"Logistics.Get.Api.Batches.Page.Integer":{"type":"integer","additionalProperties":false},"Logistics.Get.Api.Batches.Page.Size.Integer":{"type":"integer","additionalProperties":false},"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","additionalProperties":false,"items":{"type":"string","additionalProperties":false}},"display_name":{"type":"string","additionalProperties":false}}}}},"Logistics.Get.Api.Order.Is.Final.Mile.Label.Boolean":{"type":"boolean","additionalProperties":false},"Logistics.Get.Api.Order.Label.Printed.String":{"type":"string","additionalProperties":false},"Logistics.Get.Api.Order.Page.Integer":{"type":"integer","additionalProperties":false},"Logistics.Get.Api.Order.Page.Size.Integer":{"type":"integer","additionalProperties":false},"Logistics.Get.Api.Order.Printed.Date.String":{"type":"string","format":"DD/MM/YYYY","additionalProperties":false},"Logistics.Get.Api.Order.Reference.Id.Reference.Id.String":{"type":"string","additionalProperties":false},"Logistics.Get.Api.Order.Search.Search.Term.String":{"type":"string","additionalProperties":false},"Logistics.Get.Api.Order.Search.Term.String":{"type":"string","additionalProperties":false},"Logistics.Get.Api.Order.Status.String":{"type":"string","additionalProperties":false},"Logistics.Get.Api.Order.Stores.String":{"type":"string","additionalProperties":false},"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,"additionalProperties":false}}},"meta":{"type":"object","additionalProperties":false,"properties":{"customer_name":{"type":"string","additionalProperties":false},"order_id":{"type":"string","additionalProperties":false},"order_number":{"type":"string","additionalProperties":false}}},"order":{"type":"object","additionalProperties":false,"properties":{"insurance_amount":{"type":"number","additionalProperties":false},"location_id":{"type":"integer","additionalProperties":false},"measurements":{"type":"object","additionalProperties":false,"properties":{"depth_in":{"type":"number","additionalProperties":false},"length_in":{"type":"number","additionalProperties":false},"total_weight_oz":{"type":"number","additionalProperties":false},"width_in":{"type":"number","additionalProperties":false}}},"products":{"type":"array","additionalProperties":false,"items":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","additionalProperties":false},"quantity":{"type":"integer","additionalProperties":false},"sku":{"type":"string","additionalProperties":false}}}},"recipient":{"type":"object","additionalProperties":false,"properties":{"address":{"type":"object","additionalProperties":false,"properties":{"address1":{"type":"string","additionalProperties":false},"address2":{"type":"string","additionalProperties":false},"city":{"type":"string","additionalProperties":false},"country":{"type":"string","additionalProperties":false},"state":{"type":"string","additionalProperties":false},"zip_code":{"type":"string","additionalProperties":false}}},"email":{"type":"string","additionalProperties":false},"name":{"type":"string","additionalProperties":false},"phone_number":{"type":"string","additionalProperties":false}}},"reference_id":{"type":"string","additionalProperties":false},"shipping_method":{"type":"string","additionalProperties":false}}}}},"Logistics.OrderArray":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Logistics.Order"}},"Logistics.Post.Api.Order.Bulk.Cancel.OK.Object":{"type":"object","additionalProperties":false,"properties":{"is_cancelled":{"type":"boolean","example":true,"additionalProperties":false},"reason":{"type":"string","example":"Order is already Cancelled.","additionalProperties":false},"reference_id":{"type":"string","example":"ONpAfKMHa5W","additionalProperties":false}}},"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"],"additionalProperties":false,"items":{"type":"string","additionalProperties":false}}}},"Logistics.Post.Api.Order.CreateLabel.Label.Type.String":{"type":"string","additionalProperties":false,"enum":["application/pdf"]},"Logistics.Post.Api.Order.CreateLabel.OK.Object":{"type":"object","additionalProperties":false,"properties":{"interim_order_id":{"type":"string","additionalProperties":false},"label":{"type":"string","additionalProperties":false},"reference_id":{"type":"string","additionalProperties":false},"shipment_id":{"type":"integer","additionalProperties":false}}},"Logistics.Post.Api.Order.Created.Object":{"type":"object","additionalProperties":false,"properties":{"interim_order_id":{"type":"string","additionalProperties":false},"reference_id":{"type":"string","additionalProperties":false},"shipment_id":{"type":"integer","additionalProperties":false}}},"Logistics.Post.Api.Order.GenerateLabel.Bad.Request.Object":{"type":"object","additionalProperties":false,"properties":{"error":{"type":"string","example":"Invalid request parameters","additionalProperties":false}}},"Logistics.Post.Api.Order.GenerateLabel.Internal.Server.Error.Object":{"type":"object","additionalProperties":false,"properties":{"error":{"type":"string","example":"Unexpected error occurred","additionalProperties":false}}},"Logistics.Post.Api.Order.GenerateLabel.Label.Type.String":{"type":"string","additionalProperties":false,"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","additionalProperties":false}}},"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,"additionalProperties":false},"reference_id":{"type":"string","description":"Unique identifier for the order","example":"ORD-12345","additionalProperties":false}}},"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","additionalProperties":false},"order_id":{"type":"string","example":"def456","additionalProperties":false},"order_number":{"type":"string","example":"xyz789","additionalProperties":false}}},"order":{"type":"object","additionalProperties":false,"properties":{"insurance_amount":{"type":"number","example":100,"additionalProperties":false},"location_id":{"type":"integer","example":72,"additionalProperties":false},"products":{"type":"array","additionalProperties":false,"items":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","example":"spinner-green","additionalProperties":false},"quantity":{"type":"integer","example":15,"additionalProperties":false},"sku":{"type":"string","example":"s-g","additionalProperties":false}}}},"recipient":{"type":"object","additionalProperties":false,"properties":{"address":{"type":"object","additionalProperties":false,"properties":{"address1":{"type":"string","example":"123 Main St","additionalProperties":false},"address2":{"type":"string","example":"Apt 4B","additionalProperties":false},"city":{"type":"string","example":"Chicago","additionalProperties":false},"country":{"type":"string","example":"US","additionalProperties":false},"state":{"type":"string","example":"IL","additionalProperties":false},"zip_code":{"type":"string","example":60607,"additionalProperties":false}}},"email":{"type":"string","example":"einstein@example.com","additionalProperties":false},"name":{"type":"string","example":"Einstein","additionalProperties":false},"phone_number":{"type":"string","example":1234567890,"additionalProperties":false}}},"reference_id":{"type":"string","example":"abc123","additionalProperties":false},"shipping_method":{"type":"string","example":"Standard","additionalProperties":false}}}}},"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","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}}},"Logistics.Post.Api.Rate.Shopping.OK.Object":{"type":"object","additionalProperties":false,"properties":{"data":{"type":"array","additionalProperties":false,"items":{"type":"object","additionalProperties":false,"properties":{"errorMessage":{"type":"string","example":"","additionalProperties":false},"flatRate":{"type":"number","example":18.95,"additionalProperties":false},"flatRateCurrencyCode":{"type":"string","example":"USD","additionalProperties":false},"insuranceCharges":{"type":"number","description":"The insurance Charges for the package (USD)","example":400,"additionalProperties":false},"isSuccess":{"type":"boolean","example":true,"additionalProperties":false},"shipOptionDisplayName":{"type":"string","example":"Standard (Ground)","additionalProperties":false},"shippingServiceDescription":{"type":"string","example":"(USPS First Class & Priority, UPS Ground)","additionalProperties":false},"shippingServiceId":{"type":"integer","example":3,"additionalProperties":false},"surcharges":{"type":"object","additionalProperties":false,"properties":{"errorMessage":{"type":"string","example":"","additionalProperties":false},"isSuccess":{"type":"boolean","example":true,"additionalProperties":false},"surcharges":{"type":"array","additionalProperties":false,"items":{"type":"object","additionalProperties":false,"properties":{"amount":{"type":"number","example":0.45,"additionalProperties":false},"currencyCode":{"type":"string","example":"USD","additionalProperties":false},"name":{"type":"string","example":"Fuel Surcharge","additionalProperties":false}}}},"surchargesCurrencyCode":{"type":"string","example":"USD","additionalProperties":false},"totalSurchargesAmount":{"type":"number","example":0.45,"additionalProperties":false}}}}}},"errorMessage":{"type":"string","example":"","additionalProperties":false},"isSuccess":{"type":"boolean","example":true,"additionalProperties":false}}},"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,"additionalProperties":false},"destinationAddress":{"type":"object","description":"The destination address for the package","additionalProperties":false,"properties":{"address1":{"type":"string","example":"123 Main Street","additionalProperties":false},"address2":{"type":"string","example":"Suite 4B","additionalProperties":false},"city":{"type":"string","example":"Chicago","additionalProperties":false},"countryISO":{"type":"string","example":"US","additionalProperties":false},"state":{"type":"string","example":"IL","additionalProperties":false},"zipCode":{"type":"string","example":60601,"additionalProperties":false}}},"fulfillmentCenterId":{"type":"string","description":"The ID of the fulfillment center","example":10,"additionalProperties":false},"hasSignature":{"type":"boolean","description":"Whether to require signature for delivery (optional, auto-set to true if insurance >= 300)","example":false,"additionalProperties":false},"insuranceAmount":{"type":"number","description":"The insurance amount for the package (USD). Values >= 300 will require signature","minimum":0.0,"example":400,"additionalProperties":false},"packageDimensions":{"type":"object","description":"The dimensions of the package","additionalProperties":false,"properties":{"HeightInches":{"type":"number","example":6,"additionalProperties":false},"LengthInches":{"type":"number","example":12,"additionalProperties":false},"WidthInches":{"type":"number","example":8,"additionalProperties":false}}},"serviceName":{"type":"string","description":"The name of the shipping service","example":"Standard Premium","additionalProperties":false}}},"Logistics.Put.Api.Batch.Marklabelprinted.OK.Object":{"type":"object","additionalProperties":false,"properties":{"batch_id":{"type":"string","example":"60f7c0f5e1b1c8a1d4e8b123","additionalProperties":false},"printed_at":{"type":"string","format":"date-time","example":"2025-05-16T12:34:56.789Z","additionalProperties":false}}},"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","additionalProperties":false}}},"Logistics.Put.Api.Order.Marklabelprinted.OK.Object":{"type":"object","additionalProperties":false,"properties":{"_id":{"type":"string","example":"60f7c0f5e1b1c8a1d4e8b123","additionalProperties":false},"label_printed":{"type":"boolean","example":true,"additionalProperties":false},"printed_date":{"type":"string","format":"date-time","example":"2025-05-16T12:34:56.789Z","additionalProperties":false},"updated_At":{"type":"string","format":"date-time","example":"2025-05-16T12:34:56.789Z","additionalProperties":false}}},"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","additionalProperties":false},"is_final_mile_label":{"type":"boolean","description":"Flag to indicate if this is a final mile label","additionalProperties":false}}},"Logistics.Put.Api.Order.Reference.Id.Dimensions.Reference.Id.String":{"type":"string","additionalProperties":false},"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,"additionalProperties":false},"length_in":{"type":"number","example":10,"additionalProperties":false},"total_weight_oz":{"type":"number","example":15,"additionalProperties":false},"width_in":{"type":"number","example":10,"additionalProperties":false}}},"Orders.AddressType":{"type":"string","additionalProperties":false,"enum":["MarkFor","ShipFrom"]},"Orders.AddressViewModel":{"type":"object","additionalProperties":false,"required":["address1","city","country"],"properties":{"address1":{"type":"string","description":"First line of the address","minLength":1,"example":"100 Nowhere Blvd","additionalProperties":false},"address2":{"type":"string","description":"Second line of the address","example":"Suite 100","additionalProperties":false,"nullable":true},"city":{"type":"string","description":"The city","minLength":1,"example":"Gotham City","additionalProperties":false},"company_name":{"type":"string","description":"Name of the company receiving the shipment","example":"Wayne Enterprises","additionalProperties":false,"nullable":true},"country":{"type":"string","description":"The country (Must be ISO Alpha-2 for estimates)","minLength":1,"example":"US","additionalProperties":false},"state":{"type":"string","description":"The state or province","example":"NJ","additionalProperties":false,"nullable":true},"zip_code":{"type":"string","description":"The zip code or postal code","format":"postal-code","example":"07093","additionalProperties":false,"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","additionalProperties":false},"measurements":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.MeasurementsViewModel"},"recipient":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.RecipientInfoViewModel"},"reference_id":{"type":"string","description":"Unique and immutable order identifier from your upstream system","maxLength":300,"minLength":1,"additionalProperties":false},"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","additionalProperties":false}}},"Orders.Get.Api.LotExclusions.Inventory.Id.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Orders.Get.Api.LotExclusions.InventoryLotExclusionsViewModel":{"type":"object","additionalProperties":false,"properties":{"exclusions":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.Get.Api.LotExclusions.LotExclusionsViewModel"}},"inventory_id":{"type":"integer","description":"Inventory ID for excluded lot","format":"int32","additionalProperties":false}}},"Orders.Get.Api.LotExclusions.InventoryLotExclusionsViewModelArray":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.Get.Api.LotExclusions.InventoryLotExclusionsViewModel"}},"Orders.Get.Api.LotExclusions.LotDate.String":{"type":"string","format":"date-time","additionalProperties":false},"Orders.Get.Api.LotExclusions.LotExclusionsViewModel":{"type":"object","additionalProperties":false,"properties":{"location_id":{"type":"integer","description":"Id of location","format":"int32","additionalProperties":false},"lot_date":{"type":"string","description":"Lot date","format":"date-time","additionalProperties":false,"nullable":true},"lot_number":{"type":"string","description":"Lot number","additionalProperties":false,"nullable":true},"quantity":{"type":"integer","description":"Quantity available from excluded lot at location","format":"int32","additionalProperties":false}}},"Orders.Get.Api.LotExclusions.LotExclusionsViewModelArray":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.Get.Api.LotExclusions.LotExclusionsViewModel"}},"Orders.Get.Api.LotExclusions.LotNumber.String":{"type":"string","additionalProperties":false},"Orders.Get.Api.LotExclusions.Shipbob.Channel.Id.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Orders.MeasurementsViewModel":{"type":"object","description":"Measurements of a shipment","additionalProperties":false,"properties":{"depth_in":{"type":"integer","description":"Total depth in inches","format":"int32","additionalProperties":false},"length_in":{"type":"integer","description":"Total length in inches","format":"int32","additionalProperties":false},"total_weight_oz":{"type":"integer","description":"Total weight in ounces","format":"int32","additionalProperties":false},"width_in":{"type":"integer","description":"Total width in inches","format":"int32","additionalProperties":false}}},"Orders.Post.Api.Order.Transportation.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},"Orders.Post.Api.Order.Transportation.Shipbob.Channel.Id.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Orders.Post.Api.Order.Transportation.Unprocessable.Entity.Object":{"type":"object","additionalProperties":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},"Orders.Put.Api.Order.OrderId.Dimensions.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},"Orders.Put.Api.Order.OrderId.Dimensions.OrderId.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Orders.Put.Api.Order.OrderId.Dimensions.Shipbob.Channel.Id.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Orders.Put.Api.Order.OrderId.Dimensions.Unprocessable.Entity.Object":{"type":"object","additionalProperties":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},"Orders.RecipientInfoViewModel":{"type":"object","description":"Information about the recipient of an order","additionalProperties":false,"required":["address","name"],"properties":{"address":{"description":"Address of the recipient","additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Orders.AddressViewModel"},{"additionalProperties":false,"$ref":"#/components/schemas/Orders.RetailerProgramDataAddressViewModel"}]},"email":{"type":"string","description":"Email address of the recipient","format":"email","example":"john@example.com","additionalProperties":false,"nullable":true},"name":{"type":"string","description":"Name of the recipient","maxLength":300,"minLength":1,"example":"John Doe","additionalProperties":false},"phone_number":{"type":"string","description":"Phone number of the recipient","maxLength":50,"example":"555-555-5555","additionalProperties":false,"nullable":true}}},"Orders.RetailerProgramDataAddressViewModel":{"type":"object","description":"Address to used when creating a B2B/DropShip order.","additionalProperties":false,"required":["type"],"properties":{"type":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.AddressType"}},"allOf":[{"additionalProperties":false,"$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","additionalProperties":false}}},"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","additionalProperties":false},"length_in":{"type":"integer","description":"Total length in inches","format":"int32","additionalProperties":false},"total_weight_oz":{"type":"integer","description":"Total weight in ounces","format":"int32","additionalProperties":false},"width_in":{"type":"integer","description":"Total width in inches","format":"int32","additionalProperties":false}}},"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":{"additionalProperties":false,"$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","additionalProperties":false,"nullable":true},"value":{"type":"number","description":"The amount of money.","format":"double","example":12.34,"additionalProperties":false}}},"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],"additionalProperties":false,"items":{"type":"integer","format":"int32","additionalProperties":false},"nullable":true},"reason":{"type":"string","description":"The reason for the exception.","example":"Out of Stock","additionalProperties":false,"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","additionalProperties":false,"nullable":true},"fulfill_on_or_after":{"type":"string","description":"The timestamp of the earliest point a shipment should be fulfilled.","format":"date-time","additionalProperties":false,"nullable":true},"fulfillment_cost":{"additionalProperties":false,"$ref":"#/components/schemas/OrdersDataPlane.ApiCurrency"},"fulfillment_cost_applied_at":{"type":"string","format":"date-time","additionalProperties":false,"nullable":true},"label_applied_at":{"type":"string","description":"The timestamp when the shipping label was applied to the package.","format":"date-time","additionalProperties":false,"nullable":true},"label_type_id":{"type":"integer","format":"int32","additionalProperties":false,"nullable":true},"location":{"additionalProperties":false,"$ref":"#/components/schemas/OrdersDataPlane.ApiLocation"},"lot_selection_method":{"additionalProperties":false,"$ref":"#/components/schemas/OrdersDataPlane.ApiLotSelectionMethod"},"packed_at":{"type":"string","description":"The timestamp when the shipment was packed.","format":"date-time","additionalProperties":false,"nullable":true},"picked_at":{"type":"string","description":"The timestamp when the items for the shipment were picked.","format":"date-time","additionalProperties":false,"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","additionalProperties":false,"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","additionalProperties":false,"nullable":true},"sla_breach_status":{"additionalProperties":false,"$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","additionalProperties":false,"nullable":true},"status":{"additionalProperties":false,"$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,"additionalProperties":false},"name":{"type":"string","description":"The name of the fulfillment center.","example":"Philadelphia (PA)","additionalProperties":false,"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","additionalProperties":false,"nullable":true},"lot_number":{"type":"string","description":"The unique identifier assigned to the lot, which is not necessarily a number.","example":"ZYX-12345","additionalProperties":false,"nullable":true},"selection_method":{"additionalProperties":false,"$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.","additionalProperties":false,"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":{"additionalProperties":false,"$ref":"#/components/schemas/OrdersDataPlane.ApiUnitOfMeasure"},"length":{"additionalProperties":false,"$ref":"#/components/schemas/OrdersDataPlane.ApiUnitOfMeasure"},"weight":{"additionalProperties":false,"$ref":"#/components/schemas/OrdersDataPlane.ApiUnitOfMeasure"},"width":{"additionalProperties":false,"$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],"additionalProperties":false,"items":{"type":"integer","format":"int32","additionalProperties":false},"nullable":true},"reason":{"type":"string","description":"The reason why the order is on hold.","example":"International Hazmat","additionalProperties":false,"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,"additionalProperties":false},"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","additionalProperties":false,"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","additionalProperties":false,"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","additionalProperties":false,"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,"additionalProperties":false,"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","additionalProperties":false,"nullable":true},"shipping_method":{"type":"string","description":"The shipping method selected for the order as defined in the merchant's store.","example":"Express Shipping","additionalProperties":false,"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","additionalProperties":false,"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","additionalProperties":false,"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.","additionalProperties":false,"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":{"additionalProperties":false,"$ref":"#/components/schemas/OrdersDataPlane.ApiMeasurementInfo"},"package_material_type":{"additionalProperties":false,"$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,"additionalProperties":false,"nullable":true},"page_size":{"type":"integer","description":"The number of items per page.","format":"int32","example":25,"additionalProperties":false},"page_token":{"type":"string","description":"Token for the next or previous page.","example":"aBC123DeF","additionalProperties":false,"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,"additionalProperties":false},"name":{"type":"string","description":"The name of the product variant. This is a not-necessarily-unique identifier used to distinguish inventory.","example":"My Product","additionalProperties":false,"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","additionalProperties":false,"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","additionalProperties":false,"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","additionalProperties":false,"nullable":true},"city":{"type":"string","description":"The city where the recipient is located.","example":"Chicago","additionalProperties":false,"nullable":true},"company":{"type":"string","description":"The company or organization the recipient is associated with, if applicable.","example":"ShipBob","additionalProperties":false,"nullable":true},"country":{"type":"string","description":"The country of the recipient's address.","example":"US","additionalProperties":false,"nullable":true},"email":{"type":"string","description":"The recipient's email address.","example":"john.doe@example.com","additionalProperties":false,"nullable":true},"full_name":{"type":"string","description":"The full name of the recipient.","example":"John Doe","additionalProperties":false,"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.","additionalProperties":false,"nullable":true},"phone_number":{"type":"string","description":"The recipient's phone number.","example":"555-123-4567","additionalProperties":false,"nullable":true},"postal_code":{"type":"string","description":"The postal code for the recipient's address.","example":60607,"additionalProperties":false,"nullable":true},"state_or_province":{"type":"string","description":"The state or province of the recipient's address.","example":"IL","additionalProperties":false,"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":{"additionalProperties":false,"$ref":"#/components/schemas/OrdersDataPlane.ApiPageFilter"},"search_filter":{"additionalProperties":false,"$ref":"#/components/schemas/OrdersDataPlane.SearchFilter"},"sort_filters":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$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","additionalProperties":false},"fulfillment":{"additionalProperties":false,"$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","additionalProperties":false,"nullable":true},"lines":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/OrdersDataPlane.ApiShipmentLine"},"nullable":true},"packs":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/OrdersDataPlane.ApiPackInfo"},"nullable":true},"shipment_id":{"type":"integer","description":"The unique identifier for the shipment.","format":"int64","example":123456789,"additionalProperties":false},"shipping_instructions":{"additionalProperties":false,"$ref":"#/components/schemas/OrdersDataPlane.ApiShippingInfo"},"status":{"additionalProperties":false,"$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","additionalProperties":false,"nullable":true},"tracking":{"additionalProperties":false,"$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,"additionalProperties":false},"inventory_id":{"type":"integer","description":"A unique identifier for the inventory item.","format":"int32","example":1234567,"additionalProperties":false},"is_hazmat":{"type":"boolean","description":"Indicates whether the inventory item is hazardous material.","additionalProperties":false,"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.","additionalProperties":false,"nullable":true},"lot":{"additionalProperties":false,"$ref":"#/components/schemas/OrdersDataPlane.ApiLotInfo"},"product_variant":{"additionalProperties":false,"$ref":"#/components/schemas/OrdersDataPlane.ApiProductVariant"},"quantity":{"type":"integer","description":"The quantity of the inventory item requested by the shipment.","format":"int32","example":5,"additionalProperties":false},"serial_numbers":{"type":"array","description":"A list of serial numbers for the inventory item, if applicable.","example":["123a","124b","125c","126d","127e"],"additionalProperties":false,"items":{"type":"string","additionalProperties":false},"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.","additionalProperties":false,"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,"additionalProperties":false},"merchant_id":{"type":"integer","description":"The unique identifier for the merchant associated with the order.","format":"int32","example":12345,"additionalProperties":false},"order_id":{"type":"integer","description":"The unique identifier for the order.","format":"int64","example":1234567890,"additionalProperties":false},"order_type":{"additionalProperties":false,"$ref":"#/components/schemas/OrdersDataPlane.ApiOrderType"},"shipment":{"additionalProperties":false,"$ref":"#/components/schemas/OrdersDataPlane.ApiShipment"},"source":{"additionalProperties":false,"$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","additionalProperties":false,"nullable":true},"prev_page_token":{"type":"string","description":"A token to retrieve the previous page of results.","example":"-aBC123DeF","additionalProperties":false,"nullable":true},"results":{"type":"array","description":"The results on the current page.","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/OrdersDataPlane.ApiShipmentView"},"nullable":true},"total_count":{"type":"integer","description":"The total number of results.","format":"int64","example":100,"additionalProperties":false,"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!","additionalProperties":false,"nullable":true},"insured_value":{"additionalProperties":false,"$ref":"#/components/schemas/OrdersDataPlane.ApiCurrency"},"require_signature":{"type":"boolean","description":"Indicates whether a signature is required upon delivery.","additionalProperties":false},"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","additionalProperties":false,"nullable":true},"ship_to":{"additionalProperties":false,"$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","additionalProperties":false,"nullable":true}}},"OrdersDataPlane.ApiSortFilter":{"type":"object","additionalProperties":false,"properties":{"ascending":{"type":"boolean","description":"True sorts by ascending order, false sorts by descending order.","additionalProperties":false},"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","additionalProperties":false,"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","additionalProperties":false,"nullable":true},"exceptions":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/OrdersDataPlane.ApiExceptionInfo"},"nullable":true},"holds":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/OrdersDataPlane.ApiOnHoldInfo"},"nullable":true},"name":{"additionalProperties":false,"$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","additionalProperties":false,"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","additionalProperties":false,"nullable":true},"carrier_service":{"type":"string","description":"The service offered by the carrier.","example":"Ground","additionalProperties":false,"nullable":true},"delivered_at":{"type":"string","description":"The timestamp when the package was successfully delivered.","format":"date-time","additionalProperties":false,"nullable":true},"delivery_attempt_failed_at":{"type":"string","description":"The timestamp of a failed delivery attempt.","format":"date-time","additionalProperties":false,"nullable":true},"delivery_exception_at":{"type":"string","description":"The timestamp of a delivery exception, such as a delay or damage.","format":"date-time","additionalProperties":false,"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","additionalProperties":false,"nullable":true},"in_transit_at":{"type":"string","description":"The timestamp when the package was marked as in transit.","format":"date-time","additionalProperties":false,"nullable":true},"out_for_delivery_at":{"type":"string","description":"The timestamp when the package was marked as out for delivery.","format":"date-time","additionalProperties":false,"nullable":true},"status":{"additionalProperties":false,"$ref":"#/components/schemas/OrdersDataPlane.TrackingStatus"},"tracking_number":{"type":"string","description":"The tracking number assigned by the carrier.","example":"1Z9999W99999999999","additionalProperties":false,"nullable":true},"tracking_updated_at":{"type":"string","description":"The timestamp when the tracking information was last updated by the carrier.","format":"date-time","additionalProperties":false,"nullable":true},"tracking_uploaded_at":{"type":"string","description":"The timestamp when the tracking information was uploaded to ShipBob's system.","format":"date-time","additionalProperties":false,"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","additionalProperties":false,"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","additionalProperties":false,"nullable":true},"value":{"type":"number","description":"The numerical value of the measurement.","format":"double","example":12.34,"additionalProperties":false}}},"OrdersDataPlane.FulfillmentStatus":{"type":"string","description":"The status of a shipment within ShipBob. Covers both allocation and warehouse operations at a high level.","additionalProperties":false,"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.","additionalProperties":false,"enum":["Unknown","Box","BubbleMailer","PolyMailer","FragileBox","PosterTube","CustomBox","Bookfold","ShipInOwnContainer","CustomBubbleMailer","CustomPolyMailer"]},"OrdersDataPlane.SLABreachStatus":{"type":"string","additionalProperties":false,"enum":["SLANotSet","WithinEstimate","EstimatedFulfillmentDateNotSet","Breached","FulfilledOnTime"]},"OrdersDataPlane.SearchFilter":{"type":"object","discriminator":{"propertyName":"type"},"additionalProperties":false,"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","additionalProperties":false,"items":{"description":"A SearchFilter condition (recursive reference to SearchFilter schema)","additionalProperties":false}},"type":{"type":"string","additionalProperties":false,"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","additionalProperties":false,"items":{"description":"A SearchFilter condition (recursive reference to SearchFilter schema)","additionalProperties":false}},"type":{"type":"string","additionalProperties":false,"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","additionalProperties":false,"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","additionalProperties":false},"type":{"type":"string","additionalProperties":false,"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","additionalProperties":false},"type":{"type":"string","additionalProperties":false,"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","additionalProperties":false},"type":{"type":"string","additionalProperties":false,"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","additionalProperties":false},"type":{"type":"string","additionalProperties":false,"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","additionalProperties":false},"type":{"type":"string","additionalProperties":false,"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","additionalProperties":false},"type":{"type":"string","additionalProperties":false,"enum":["in"]},"values":{"type":"array","description":"Array of values to check for inclusion","additionalProperties":false,"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.","additionalProperties":false},"type":{"type":"string","additionalProperties":false,"enum":["text"]},"value":{"type":"string","description":"The text to search for","additionalProperties":false}}}]},"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.","additionalProperties":false,"enum":["AwaitingScan","Processing","InTransit","OutForDelivery","DeliveryAttemptFailed","DeliveryException","Delivered"]},"Products.AdditionalHazmatAttributesRequestModel":{"type":"object","additionalProperties":false,"properties":{"charge_state_percentage":{"type":"number","format":"double","additionalProperties":false,"nullable":true},"container_metal":{"type":"boolean","additionalProperties":false,"nullable":true},"lithium_battery_packaging":{"type":"string","additionalProperties":false,"nullable":true},"lithium_battery_type":{"type":"string","additionalProperties":false,"nullable":true},"magnet":{"type":"boolean","additionalProperties":false,"nullable":true},"net_volume":{"type":"number","format":"double","additionalProperties":false,"nullable":true},"net_weight":{"type":"number","format":"double","additionalProperties":false,"nullable":true}}},"Products.AdditionalHazmatAttributesViewModel":{"type":"object","additionalProperties":false,"properties":{"charge_state_percentage":{"type":"number","format":"double","additionalProperties":false,"nullable":true},"container_metal":{"type":"boolean","additionalProperties":false,"nullable":true},"lithium_battery_packaging":{"type":"string","additionalProperties":false,"nullable":true},"lithium_battery_type":{"type":"string","additionalProperties":false,"nullable":true},"magnet":{"type":"boolean","additionalProperties":false,"nullable":true},"net_volume":{"type":"number","format":"double","additionalProperties":false,"nullable":true},"net_weight":{"type":"number","format":"double","additionalProperties":false,"nullable":true}}},"Products.AmazonChannelMetadataRequestModel":{"type":"object","description":"Amazon Sales Channel Information with custom Amazon Fields","additionalProperties":false,"properties":{"asin":{"type":"string","additionalProperties":false,"nullable":true},"fnsku":{"type":"string","additionalProperties":false,"nullable":true},"fulfillment_channel":{"type":"string","additionalProperties":false,"nullable":true},"platform":{"type":"string","readOnly":true,"additionalProperties":false,"nullable":true}},"allOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.ChannelMetadataRequestModel"}]},"Products.AmazonChannelMetadataViewModel":{"type":"object","additionalProperties":false,"properties":{"asin":{"type":"string","additionalProperties":false,"nullable":true},"fnsku":{"type":"string","additionalProperties":false,"nullable":true},"fulfillment_channel":{"type":"string","additionalProperties":false,"nullable":true}},"allOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.ChannelMetadataViewModel"}]},"Products.AmazonProductChannelMetadataModel":{"type":"object","additionalProperties":false,"properties":{"asin":{"type":"string","additionalProperties":false,"nullable":true},"fnsku":{"type":"string","additionalProperties":false,"nullable":true},"fulfillment_channel":{"type":"string","additionalProperties":false,"nullable":true}},"allOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.BaseProductChannelMetadataModel"}]},"Products.ApplicableCategoryViewModel":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32","additionalProperties":false},"sub_category_ids":{"type":"array","additionalProperties":false,"items":{"type":"integer","format":"int32","additionalProperties":false},"nullable":true}}},"Products.AssociatedBundlesViewModel":{"type":"object","additionalProperties":false,"properties":{"product_id":{"type":"integer","format":"int64","additionalProperties":false},"product_name":{"type":"string","additionalProperties":false,"nullable":true},"quantity":{"type":"integer","format":"int32","additionalProperties":false},"variant_id":{"type":"integer","format":"int64","additionalProperties":false},"variant_sku":{"type":"string","additionalProperties":false,"nullable":true}}},"Products.BarcodeModel":{"type":"object","additionalProperties":false,"properties":{"sticker_url":{"type":"string","additionalProperties":false,"nullable":true},"value":{"type":"string","additionalProperties":false,"nullable":true}}},"Products.BarcodeRequestModel":{"type":"object","additionalProperties":false,"properties":{"sticker_url":{"type":"string","additionalProperties":false,"nullable":true},"value":{"type":"string","additionalProperties":false,"nullable":true}}},"Products.BarcodeViewModel":{"type":"object","additionalProperties":false,"properties":{"sticker_url":{"type":"string","additionalProperties":false,"nullable":true},"value":{"type":"string","additionalProperties":false,"nullable":true}}},"Products.BaseAdditionalHazmatAttributesModel":{"type":"object","additionalProperties":false,"properties":{"charge_state_percentage":{"type":"number","format":"double","additionalProperties":false,"nullable":true},"container_metal":{"type":"boolean","additionalProperties":false,"nullable":true},"lithium_battery_packaging":{"type":"string","additionalProperties":false,"nullable":true},"lithium_battery_type":{"type":"string","additionalProperties":false,"nullable":true},"magnet":{"type":"boolean","additionalProperties":false,"nullable":true},"net_volume":{"type":"number","format":"double","additionalProperties":false,"nullable":true},"net_weight":{"type":"number","format":"double","additionalProperties":false,"nullable":true}}},"Products.BaseBundleDefinitionModel":{"type":"object","additionalProperties":false,"properties":{"quantity":{"type":"integer","format":"int32","additionalProperties":false},"variant_id":{"type":"integer","format":"int64","additionalProperties":false}}},"Products.BaseChannelMetadataRequestModel":{"type":"object","description":"Standard Channel Metadata Record to store SellerSKU for a Sales Channel","additionalProperties":false,"allOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.ChannelMetadataRequestModel"}]},"Products.BaseCustomsModel":{"type":"object","additionalProperties":false,"properties":{"country_code_of_origin":{"type":"string","additionalProperties":false,"nullable":true},"currency":{"type":"string","additionalProperties":false,"nullable":true},"description":{"type":"string","additionalProperties":false,"nullable":true},"hs_tariff_code":{"type":"string","additionalProperties":false,"nullable":true},"is321_eligible":{"type":"boolean","additionalProperties":false},"value":{"type":"integer","format":"int32","additionalProperties":false,"nullable":true}}},"Products.BaseDimensionModel":{"type":"object","additionalProperties":false,"properties":{"height":{"type":"number","format":"double","additionalProperties":false},"length":{"type":"number","format":"double","additionalProperties":false},"width":{"type":"number","format":"double","additionalProperties":false}}},"Products.BaseFulfillmentSettingsModel":{"type":"object","additionalProperties":false,"properties":{"dangerous_goods":{"type":"boolean","additionalProperties":false},"is_bpm_parcel":{"type":"boolean","additionalProperties":false},"is_case_pick":{"type":"boolean","additionalProperties":false},"msds_url":{"type":"string","additionalProperties":false,"nullable":true},"requires_prop65":{"type":"boolean","additionalProperties":false},"serial_scan":{"additionalProperties":false,"$ref":"#/components/schemas/Products.BaseSerialScanModel"}}},"Products.BaseLotInformationModel":{"type":"object","additionalProperties":false,"properties":{"is_lot":{"type":"boolean","additionalProperties":false},"minimum_shelf_life_days":{"type":"integer","format":"int32","additionalProperties":false,"nullable":true}}},"Products.BaseProductChannelMetadataModel":{"type":"object","additionalProperties":false,"allOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.ProductChannelMetadataModel"}]},"Products.BaseProductRequestModel":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","additionalProperties":false,"nullable":true},"taxonomy_id":{"type":"integer","format":"int32","additionalProperties":false,"nullable":true},"type_id":{"type":"integer","format":"int32","additionalProperties":false}}},"Products.BaseProductVariantModel":{"type":"object","additionalProperties":false,"properties":{"additional_hazmat_attributes":{"additionalProperties":false,"$ref":"#/components/schemas/Products.BaseAdditionalHazmatAttributesModel"},"bundle_definition":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Products.BaseBundleDefinitionModel"},"nullable":true},"channel_metadata":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.AmazonProductChannelMetadataModel"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.BaseProductChannelMetadataModel"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.BigCommerceProductChannelMetadataModel"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.ShopifyProductChannelMetadataModel"}]},"nullable":true},"customs":{"additionalProperties":false,"$ref":"#/components/schemas/Products.BaseCustomsModel"},"dimension":{"additionalProperties":false,"$ref":"#/components/schemas/Products.BaseDimensionModel"},"fulfillment_settings":{"additionalProperties":false,"$ref":"#/components/schemas/Products.BaseFulfillmentSettingsModel"},"gtin":{"type":"string","additionalProperties":false,"nullable":true},"is_digital":{"type":"boolean","additionalProperties":false},"lot_information":{"additionalProperties":false,"$ref":"#/components/schemas/Products.BaseLotInformationModel"},"name":{"type":"string","additionalProperties":false,"nullable":true},"packaging_material_type_id":{"type":"integer","format":"int32","additionalProperties":false,"nullable":true},"packaging_requirement_id":{"type":"integer","format":"int32","additionalProperties":false,"nullable":true},"return_preferences":{"additionalProperties":false,"$ref":"#/components/schemas/Products.BaseReturnPreferencesModel"},"reviews_pending":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Products.ReviewsPendingType"},"nullable":true},"sku":{"type":"string","additionalProperties":false,"nullable":true},"status":{"additionalProperties":false,"$ref":"#/components/schemas/Products.VariantStatus"},"upc":{"type":"string","additionalProperties":false,"nullable":true},"weight":{"type":"number","format":"double","additionalProperties":false}}},"Products.BaseProductVariantRequestModel":{"type":"object","additionalProperties":false,"properties":{"additional_hazmat_attributes":{"additionalProperties":false,"$ref":"#/components/schemas/Products.AdditionalHazmatAttributesRequestModel"},"bundle_definition":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Products.BundleDefinitionRequestModel"},"nullable":true},"channel_metadata":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.AmazonChannelMetadataRequestModel"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.BaseChannelMetadataRequestModel"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.BigCommerceChannelMetadataRequestModel"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.ShopifyChannelMetadataRequestModel"}]},"nullable":true},"customs":{"additionalProperties":false,"$ref":"#/components/schemas/Products.CustomsRequestModel"},"dimension":{"additionalProperties":false,"$ref":"#/components/schemas/Products.DimensionRequestModel"},"fulfillment_settings":{"additionalProperties":false,"$ref":"#/components/schemas/Products.FulfillmentSettingsRequestModel"},"gtin":{"type":"string","additionalProperties":false,"nullable":true},"is_digital":{"type":"boolean","additionalProperties":false},"lot_information":{"additionalProperties":false,"$ref":"#/components/schemas/Products.LotInformationRequestModel"},"name":{"type":"string","additionalProperties":false,"nullable":true},"packaging_material_type_id":{"type":"integer","format":"int32","additionalProperties":false,"nullable":true},"packaging_requirement_id":{"type":"integer","format":"int32","additionalProperties":false,"nullable":true},"return_preferences":{"additionalProperties":false,"$ref":"#/components/schemas/Products.ReturnPreferencesRequestModel"},"sku":{"type":"string","additionalProperties":false,"nullable":true},"status_id":{"type":"integer","format":"int32","additionalProperties":false},"upc":{"type":"string","additionalProperties":false,"nullable":true},"weight":{"type":"number","format":"double","additionalProperties":false}}},"Products.BaseReturnPreferencesModel":{"type":"object","additionalProperties":false,"properties":{"backup_action_id":{"type":"integer","format":"int32","additionalProperties":false,"nullable":true},"instructions":{"type":"string","additionalProperties":false,"nullable":true},"primary_action_id":{"type":"integer","format":"int32","additionalProperties":false},"return_to_sender_backup_action_id":{"type":"integer","format":"int32","additionalProperties":false,"nullable":true},"return_to_sender_primary_action_id":{"type":"integer","format":"int32","additionalProperties":false,"nullable":true}}},"Products.BaseSerialScanModel":{"type":"object","additionalProperties":false,"properties":{"exact_character_length":{"type":"integer","format":"int32","additionalProperties":false,"nullable":true},"is_enabled":{"type":"boolean","additionalProperties":false},"prefix":{"type":"string","additionalProperties":false,"nullable":true},"suffix":{"type":"string","additionalProperties":false,"nullable":true}}},"Products.BaseTaxonomyViewModel":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32","additionalProperties":false},"name":{"type":"string","additionalProperties":false,"nullable":true},"path":{"type":"string","additionalProperties":false,"nullable":true}}},"Products.BigCommerceChannelMetadataRequestModel":{"type":"object","description":"BigCommerce Sales Channel Information with custom Amazon Fields","additionalProperties":false,"properties":{"platform":{"type":"string","readOnly":true,"additionalProperties":false,"nullable":true},"platform_product_id":{"type":"integer","format":"int64","additionalProperties":false,"nullable":true},"platform_variant_id":{"type":"integer","format":"int64","additionalProperties":false,"nullable":true}},"allOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.ChannelMetadataRequestModel"}]},"Products.BigCommerceChannelMetadataViewModel":{"type":"object","additionalProperties":false,"properties":{"platform_product_id":{"type":"integer","format":"int64","additionalProperties":false,"nullable":true},"platform_variant_id":{"type":"integer","format":"int64","additionalProperties":false,"nullable":true}},"allOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.ChannelMetadataViewModel"}]},"Products.BigCommerceProductChannelMetadataModel":{"type":"object","additionalProperties":false,"properties":{"platform_product_id":{"type":"integer","format":"int64","additionalProperties":false,"nullable":true},"platform_variant_id":{"type":"integer","format":"int64","additionalProperties":false,"nullable":true}},"allOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.BaseProductChannelMetadataModel"}]},"Products.BundleDefinitionRequestModel":{"type":"object","additionalProperties":false,"properties":{"quantity":{"type":"integer","format":"int32","additionalProperties":false},"variant_id":{"type":"integer","format":"int64","additionalProperties":false}}},"Products.BundleDefinitionViewModel":{"type":"object","additionalProperties":false,"properties":{"product_id":{"type":"integer","format":"int64","additionalProperties":false},"quantity":{"type":"integer","format":"int32","additionalProperties":false},"variant_id":{"type":"integer","format":"int64","additionalProperties":false},"variant_name":{"type":"string","additionalProperties":false,"nullable":true},"variant_sku":{"type":"string","additionalProperties":false,"nullable":true}}},"Products.ChannelMetadataRequestModel":{"type":"object","additionalProperties":false,"properties":{"channel_id":{"type":"integer","format":"int32","additionalProperties":false,"nullable":true},"currency":{"type":"string","additionalProperties":false,"nullable":true},"id":{"type":"integer","format":"int64","additionalProperties":false,"nullable":true},"is_inventory_sync_enabled":{"type":"boolean","additionalProperties":false},"legacy_product_id":{"type":"integer","format":"int64","additionalProperties":false,"nullable":true},"platform":{"type":"string","additionalProperties":false,"nullable":true},"platform_identifier":{"type":"string","additionalProperties":false,"nullable":true},"platform_inventory_item_id":{"type":"string","additionalProperties":false,"nullable":true},"price":{"type":"number","format":"double","additionalProperties":false},"seller_sku":{"type":"string","additionalProperties":false,"nullable":true}}},"Products.ChannelMetadataViewModel":{"type":"object","additionalProperties":false,"properties":{"channel_id":{"type":"integer","format":"int64","additionalProperties":false},"channel_name":{"type":"string","additionalProperties":false,"nullable":true},"currency":{"type":"string","additionalProperties":false,"nullable":true},"id":{"type":"integer","format":"int64","additionalProperties":false},"is_inventory_sync_enabled":{"type":"boolean","additionalProperties":false},"legacy_product_id":{"type":"integer","format":"int64","additionalProperties":false,"nullable":true},"platform":{"type":"string","additionalProperties":false,"nullable":true},"platform_identifier":{"type":"string","additionalProperties":false,"nullable":true},"platform_inventory_item_id":{"type":"string","additionalProperties":false,"nullable":true},"price":{"type":"number","format":"double","additionalProperties":false},"seller_sku":{"type":"string","additionalProperties":false,"nullable":true}}},"Products.ChildTaxonomyViewModel":{"type":"object","additionalProperties":false,"properties":{"has_children":{"type":"boolean","additionalProperties":false}},"allOf":[{"additionalProperties":false,"$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","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Products.BundleDefinitionRequestModel"},"nullable":true},"channel_metadata":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.AmazonChannelMetadataRequestModel"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.BaseChannelMetadataRequestModel"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.BigCommerceChannelMetadataRequestModel"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.ShopifyChannelMetadataRequestModel"}]},"nullable":true},"name":{"type":"string","additionalProperties":false,"nullable":true},"sku":{"type":"string","additionalProperties":false,"nullable":true}}},"Products.CreateProductRequestModelV3":{"type":"object","additionalProperties":false,"properties":{"variants":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Products.CreateProductVariantRequestModelV3"},"nullable":true}},"allOf":[{"additionalProperties":false,"$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}]},"additionalProperties":false,"properties":{"variants":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Products.CreateProductVariantRequestModelV5"},"nullable":true}},"allOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.BaseProductRequestModel"}]},"Products.CreateProductVariantRequestModel":{"type":"object","additionalProperties":false,"allOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.BaseProductVariantRequestModel"}]},"Products.CreateProductVariantRequestModelV3":{"type":"object","additionalProperties":false,"properties":{"barcode_sticker_url":{"type":"string","additionalProperties":false,"nullable":true}},"allOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.CreateProductVariantRequestModel"}]},"Products.CreateProductVariantRequestModelV3Array":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Products.CreateProductVariantRequestModelV3"}},"Products.CreateProductVariantRequestModelV5":{"type":"object","additionalProperties":false,"properties":{"barcodes":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Products.BarcodeRequestModel"},"nullable":true}},"allOf":[{"additionalProperties":false,"$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}],"additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Products.CreateProductVariantRequestModelV5"}},"Products.CustomsRequestModel":{"type":"object","additionalProperties":false,"properties":{"country_code_of_origin":{"type":"string","additionalProperties":false,"nullable":true},"description":{"type":"string","additionalProperties":false,"nullable":true},"hs_tariff_code":{"type":"string","additionalProperties":false,"nullable":true},"is321_eligible":{"type":"boolean","additionalProperties":false},"value":{"type":"integer","format":"int32","additionalProperties":false,"nullable":true}}},"Products.CustomsViewModel":{"type":"object","additionalProperties":false,"properties":{"country_code_of_origin":{"type":"string","additionalProperties":false,"nullable":true},"currency":{"type":"string","additionalProperties":false,"nullable":true},"description":{"type":"string","additionalProperties":false,"nullable":true},"hs_tariff_code":{"type":"string","additionalProperties":false,"nullable":true},"is321_eligible":{"type":"boolean","additionalProperties":false},"value":{"type":"integer","format":"int32","additionalProperties":false,"nullable":true}}},"Products.Delete.Api.V2.Variant.VariantId.Channel.Metadata.ChannelMetadataId.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},"Products.Delete.Api.V2.Variant.VariantId.Channel.Metadata.ChannelMetadataId.ChannelMetadataId.Integer":{"type":"integer","format":"int64","additionalProperties":false},"Products.Delete.Api.V2.Variant.VariantId.Channel.Metadata.ChannelMetadataId.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails":{"additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.ProblemDetails"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Delete.Api.V2.Variant.VariantId.Channel.Metadata.ChannelMetadataId.VariantId.Integer":{"type":"integer","format":"int64","additionalProperties":false},"Products.Delete.Api.V4.Product.ProductId.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},"Products.Delete.Api.V4.Product.ProductId.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails":{"additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.ProblemDetails"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Delete.Api.V4.Product.ProductId.ProductId.Integer":{"type":"integer","format":"int64","additionalProperties":false},"Products.Delete.Api.V5.Product.ProductId.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},"Products.Delete.Api.V5.Product.ProductId.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails":{"additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.ProblemDetails"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Delete.Api.V5.Product.ProductId.ProductId.Integer":{"type":"integer","format":"int64","additionalProperties":false},"Products.Delete.Api.V5.Variant.VariantId.Channel.Metadata.ChannelMetadataId.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},"Products.Delete.Api.V5.Variant.VariantId.Channel.Metadata.ChannelMetadataId.ChannelMetadataId.Integer":{"type":"integer","format":"int64","additionalProperties":false},"Products.Delete.Api.V5.Variant.VariantId.Channel.Metadata.ChannelMetadataId.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails":{"additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.ProblemDetails"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Delete.Api.V5.Variant.VariantId.Channel.Metadata.ChannelMetadataId.VariantId.Integer":{"type":"integer","format":"int64","additionalProperties":false},"Products.DimensionRequestModel":{"type":"object","additionalProperties":false,"properties":{"height":{"type":"number","format":"double","additionalProperties":false},"length":{"type":"number","format":"double","additionalProperties":false},"width":{"type":"number","format":"double","additionalProperties":false}}},"Products.DimensionViewModel":{"type":"object","additionalProperties":false,"properties":{"height":{"type":"number","format":"double","additionalProperties":false},"is_locked":{"type":"boolean","additionalProperties":false},"length":{"type":"number","format":"double","additionalProperties":false},"source":{"type":"string","additionalProperties":false,"nullable":true},"unit":{"type":"string","additionalProperties":false,"nullable":true},"width":{"type":"number","format":"double","additionalProperties":false}}},"Products.EnumViewModel":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int64","additionalProperties":false},"name":{"type":"string","additionalProperties":false,"nullable":true}}},"Products.FulfillmentSettingsRequestModel":{"type":"object","additionalProperties":false,"properties":{"dangerous_goods":{"type":"boolean","additionalProperties":false},"is_bpm_parcel":{"type":"boolean","additionalProperties":false},"is_case_pick":{"type":"boolean","additionalProperties":false},"msds_url":{"type":"string","additionalProperties":false,"nullable":true},"requires_prop65":{"type":"boolean","additionalProperties":false},"serial_scan":{"additionalProperties":false,"$ref":"#/components/schemas/Products.SerialScanRequestModel"}}},"Products.FulfillmentSettingsViewModel":{"type":"object","additionalProperties":false,"properties":{"dangerous_goods":{"type":"boolean","additionalProperties":false},"is_bpm_parcel":{"type":"boolean","additionalProperties":false},"is_case_pick":{"type":"boolean","additionalProperties":false},"msds_url":{"type":"string","additionalProperties":false,"nullable":true},"requires_prop65":{"type":"boolean","additionalProperties":false},"serial_scan":{"additionalProperties":false,"$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","additionalProperties":false},"Products.Get.Api.V4.Product.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},"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":{"additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.ProblemDetails"},{"additionalProperties":false,"$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","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},"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":{"additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.ProblemDetails"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Get.Api.V4.Product.ProductId.ProductId.Integer":{"type":"integer","format":"int64","additionalProperties":false},"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","additionalProperties":false},"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","additionalProperties":false},"Products.Get.Api.V4.Product.SortOrder.String":{"type":"string","additionalProperties":false},"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":{"additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.ProblemDetails"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Get.Api.V4.Taxonomy.Id.Forbidden.OneOf.ProblemDetails.HttpValidationProblemDetails":{"additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.ProblemDetails"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Get.Api.V4.Taxonomy.Id.Id.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Products.Get.Api.V4.Taxonomy.Id.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails":{"additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.ProblemDetails"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Get.Api.V4.Taxonomy.Id.Parent.Forbidden.OneOf.ProblemDetails.HttpValidationProblemDetails":{"additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.ProblemDetails"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Get.Api.V4.Taxonomy.Id.Parent.Id.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Products.Get.Api.V4.Taxonomy.Id.Parent.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails":{"additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.ProblemDetails"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Get.Api.V4.Taxonomy.Id.Parent.Unauthorized.OneOf.ProblemDetails.HttpValidationProblemDetails":{"additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.ProblemDetails"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Get.Api.V4.Taxonomy.Id.Unauthorized.OneOf.ProblemDetails.HttpValidationProblemDetails":{"additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.ProblemDetails"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Get.Api.V4.Taxonomy.Search.String":{"type":"string","additionalProperties":false},"Products.Get.Api.V4.Taxonomy.Unauthorized.OneOf.ProblemDetails.HttpValidationProblemDetails":{"additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.ProblemDetails"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Get.Api.V5.Product.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},"Products.Get.Api.V5.Product.Barcode.Int":{"type":"integer","description":"Barcode Associated with variant","additionalProperties":false},"Products.Get.Api.V5.Product.Barcode.String":{"type":"string","description":"Barcode Associated with variant","additionalProperties":false},"Products.Get.Api.V5.Product.CategoryIds.List.Int":{"type":"array","description":"List of Category Ids associated with product","additionalProperties":false,"items":{"type":"integer","additionalProperties":false}},"Products.Get.Api.V5.Product.ChannelIds.List.Int":{"type":"array","description":"Looks for Products variants by their channel IDs","additionalProperties":false,"items":{"type":"integer","additionalProperties":false}},"Products.Get.Api.V5.Product.HasDigitalVariants.Boolean":{"type":"boolean","description":"Looks for Products with/without digital variants","additionalProperties":false},"Products.Get.Api.V5.Product.HasVariants.Boolean":{"type":"boolean","description":"Looks for Products with/without variants","additionalProperties":false},"Products.Get.Api.V5.Product.InventoryId.List.Int":{"type":"array","description":"Looks for variants by its associated inventory id","additionalProperties":false,"items":{"type":"integer","additionalProperties":false}},"Products.Get.Api.V5.Product.LegacyIds.List.Int":{"type":"array","description":"Looks for Products with by Legacy Product Id(s)","additionalProperties":false,"items":{"type":"integer","additionalProperties":false}},"Products.Get.Api.V5.Product.Name.String":{"type":"string","description":"Looks for Products/Variants by name","additionalProperties":false},"Products.Get.Api.V5.Product.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails":{"additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.ProblemDetails"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Get.Api.V5.Product.OnHand.Integer":{"type":"integer","description":"Looks for Products with inventory","additionalProperties":false},"Products.Get.Api.V5.Product.PageSize.Int":{"type":"integer","additionalProperties":false},"Products.Get.Api.V5.Product.PlatformIds.List.String":{"type":"array","description":"Looks for Products variants by their external Platform IDs","additionalProperties":false,"items":{"type":"string","additionalProperties":false}},"Products.Get.Api.V5.Product.ProductId.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},"Products.Get.Api.V5.Product.ProductId.List.Int":{"type":"array","description":"Looks for Products with an assigned Id","additionalProperties":false,"items":{"type":"integer","additionalProperties":false}},"Products.Get.Api.V5.Product.ProductId.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails":{"additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.ProblemDetails"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Get.Api.V5.Product.ProductId.ProductId.Integer":{"type":"integer","format":"int64","additionalProperties":false},"Products.Get.Api.V5.Product.ProductId.Variants.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},"Products.Get.Api.V5.Product.ProductId.Variants.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails":{"additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.ProblemDetails"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Get.Api.V5.Product.ProductId.Variants.ProductId.Integer":{"type":"integer","format":"int64","additionalProperties":false},"Products.Get.Api.V5.Product.ProductType.Integer":{"type":"integer","description":"Looks for Products by type","additionalProperties":false},"Products.Get.Api.V5.Product.ReviewsPending.List.ReviewsPendingType":{"type":"array","description":"Looks for Products by ReviewsPending","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Products.ReviewsPendingType"}},"Products.Get.Api.V5.Product.SKU.String":{"type":"string","description":"Looks for Products that match the provided Sku query","additionalProperties":false},"Products.Get.Api.V5.Product.SalesChannel.List.String":{"type":"array","description":"Looks for Products variants assigned to a platform/sales channel ","additionalProperties":false,"items":{"type":"string","additionalProperties":false}},"Products.Get.Api.V5.Product.Search.String":{"type":"string","description":"Search Products by name, sku, inventory id or product Id","additionalProperties":false},"Products.Get.Api.V5.Product.SellerSKU.String":{"type":"string","description":"Looks for Products that match the provided Seller query","additionalProperties":false},"Products.Get.Api.V5.Product.SortBy.String":{"type":"string","additionalProperties":false},"Products.Get.Api.V5.Product.SortOrder.String":{"type":"string","additionalProperties":false},"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","additionalProperties":false,"items":{"type":"integer","additionalProperties":false}},"Products.Get.Api.V5.Product.VariantId.List.Int":{"type":"array","description":"Looks for products that contain a variant with the given ID","additionalProperties":false,"items":{"type":"integer","additionalProperties":false}},"Products.Get.Api.V5.Product.VariantStatus.String":{"type":"string","description":"Looks for Products with variants that contain provided status","additionalProperties":false},"Products.Get.Api.V5.Taxonomy.Forbidden.OneOf.ProblemDetails.HttpValidationProblemDetails":{"additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.ProblemDetails"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Get.Api.V5.Taxonomy.Id.Forbidden.OneOf.ProblemDetails.HttpValidationProblemDetails":{"additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.ProblemDetails"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Get.Api.V5.Taxonomy.Id.Id.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Products.Get.Api.V5.Taxonomy.Id.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails":{"additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.ProblemDetails"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Get.Api.V5.Taxonomy.Id.Parent.Forbidden.OneOf.ProblemDetails.HttpValidationProblemDetails":{"additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.ProblemDetails"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Get.Api.V5.Taxonomy.Id.Parent.Id.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Products.Get.Api.V5.Taxonomy.Id.Parent.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails":{"additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.ProblemDetails"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Get.Api.V5.Taxonomy.Id.Parent.Unauthorized.OneOf.ProblemDetails.HttpValidationProblemDetails":{"additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.ProblemDetails"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Get.Api.V5.Taxonomy.Id.Unauthorized.OneOf.ProblemDetails.HttpValidationProblemDetails":{"additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.ProblemDetails"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Get.Api.V5.Taxonomy.Search.String":{"type":"string","additionalProperties":false},"Products.Get.Api.V5.Taxonomy.Unauthorized.OneOf.ProblemDetails.HttpValidationProblemDetails":{"additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.ProblemDetails"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.HttpValidationProblemDetails":{"type":"object","additionalProperties":{"additionalProperties":false},"properties":{"errors":{"type":"object","additionalProperties":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}},"nullable":true}},"allOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.ProblemDetails"}]},"Products.InventoryViewModel":{"type":"object","additionalProperties":false,"properties":{"inventory_id":{"type":"integer","format":"int32","additionalProperties":false,"nullable":true},"on_hand_qty":{"type":"integer","format":"int32","additionalProperties":false}}},"Products.LotInformationRequestModel":{"type":"object","additionalProperties":false,"properties":{"is_lot":{"type":"boolean","additionalProperties":false},"minimum_shelf_life_days":{"type":"integer","format":"int32","additionalProperties":false,"nullable":true}}},"Products.LotInformationViewModel":{"type":"object","additionalProperties":false,"properties":{"is_lot":{"type":"boolean","additionalProperties":false},"minimum_shelf_life_days":{"type":"integer","format":"int32","additionalProperties":false,"nullable":true}}},"Products.MergeVariantRequestModel":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int64","additionalProperties":false}}},"Products.MergeVariantRequestModelArray":{"type":"array","example":[{"id":0}],"additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Products.MergeVariantRequestModel"}},"Products.MergedChildrenViewModel":{"type":"object","additionalProperties":false,"properties":{"channel_ids":{"type":"array","additionalProperties":false,"items":{"type":"integer","format":"int64","additionalProperties":false},"nullable":true},"completed_at":{"type":"string","format":"date-time","additionalProperties":false},"inventory_id":{"type":"integer","format":"int64","additionalProperties":false,"nullable":true},"variant_id":{"type":"integer","format":"int64","additionalProperties":false},"variant_name":{"type":"string","additionalProperties":false,"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","additionalProperties":false,"nullable":true},"name":{"type":"string","additionalProperties":false,"nullable":true},"product_id":{"type":"integer","format":"int64","additionalProperties":false},"sub_category_id":{"type":"integer","format":"int32","additionalProperties":false,"nullable":true},"taxonomy_id":{"type":"integer","format":"int32","additionalProperties":false,"nullable":true},"variants":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Products.VariantToMigrate"},"nullable":true}}},"Products.PackagingMaterialTypeViewModel":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32","additionalProperties":false},"name":{"type":"string","additionalProperties":false,"nullable":true}}},"Products.PackagingRequirementViewModel":{"type":"object","additionalProperties":false,"properties":{"applicable_categories":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Products.ApplicableCategoryViewModel"},"nullable":true},"applicable_packaging_material_types":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Products.PackagingMaterialTypeViewModel"},"nullable":true},"applicable_taxonomy":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false},"nullable":true},"description":{"type":"string","additionalProperties":false,"nullable":true},"id":{"type":"integer","format":"int32","additionalProperties":false},"name":{"type":"string","additionalProperties":false,"nullable":true}}},"Products.PackagingRequirementViewModelArray":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Products.PackagingRequirementViewModel"}},"Products.Patch.Api.V4.Product.ProductId.ProductId.Integer":{"type":"integer","format":"int64","additionalProperties":false},"Products.Patch.Api.V4.Product.ProductId.Variants.ProductId.Integer":{"type":"integer","format":"int64","additionalProperties":false},"Products.Patch.Api.V5.Product.ProductId.ProductId.Integer":{"type":"integer","format":"int64","additionalProperties":false},"Products.Patch.Api.V5.Product.ProductId.Variants.ProductId.Integer":{"type":"integer","format":"int64","additionalProperties":false},"Products.Post.Api.V2.Variant.VariantId.Channel.Metadata.Request.OneOf.AmazonChannelMetadataRequestModel.BaseChannelMetadataRequestModel.BigCommerceChannelMetadataRequestModel.ShopifyChannelMetadataRequestModel":{"additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.AmazonChannelMetadataRequestModel"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.BaseChannelMetadataRequestModel"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.BigCommerceChannelMetadataRequestModel"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.ShopifyChannelMetadataRequestModel"}]},"Products.Post.Api.V2.Variant.VariantId.Channel.Metadata.VariantId.Integer":{"type":"integer","format":"int64","additionalProperties":false},"Products.Post.Api.V2.Variant.VariantId.ConvertToBundle.VariantId.Integer":{"type":"integer","format":"int64","additionalProperties":false},"Products.Post.Api.V2.Variant.VariantId.Merge.VariantId.Integer":{"type":"integer","format":"int64","additionalProperties":false},"Products.Post.Api.V4.Product.MoveVariants.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},"Products.Post.Api.V4.Product.MoveVariants.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails":{"additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.ProblemDetails"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Post.Api.V4.Product.ProductId.MoveVariants.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},"Products.Post.Api.V4.Product.ProductId.MoveVariants.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails":{"additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.ProblemDetails"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Post.Api.V4.Product.ProductId.MoveVariants.ProductId.Integer":{"type":"integer","format":"int64","additionalProperties":false},"Products.Post.Api.V4.Product.ProductId.Variants.ProductId.Integer":{"type":"integer","format":"int64","additionalProperties":false},"Products.Post.Api.V5.Product.MoveVariants.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},"Products.Post.Api.V5.Product.MoveVariants.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails":{"additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.ProblemDetails"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Post.Api.V5.Product.ProductId.MoveVariants.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},"Products.Post.Api.V5.Product.ProductId.MoveVariants.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails":{"additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.ProblemDetails"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Post.Api.V5.Product.ProductId.MoveVariants.ProductId.Integer":{"type":"integer","format":"int64","additionalProperties":false},"Products.Post.Api.V5.Product.ProductId.Variants.ProductId.Integer":{"type":"integer","format":"int64","additionalProperties":false},"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"},"additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.AmazonChannelMetadataRequestModel"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.BaseChannelMetadataRequestModel"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.BigCommerceChannelMetadataRequestModel"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.ShopifyChannelMetadataRequestModel"}]},"Products.Post.Api.V5.Variant.VariantId.Channel.Metadata.VariantId.Integer":{"type":"integer","format":"int64","additionalProperties":false},"Products.Post.Api.V5.Variant.VariantId.ConvertToBundle.VariantId.Integer":{"type":"integer","format":"int64","additionalProperties":false},"Products.Post.Api.V5.Variant.VariantId.Merge.VariantId.Integer":{"type":"integer","format":"int64","additionalProperties":false},"Products.ProblemDetails":{"type":"object","additionalProperties":{"additionalProperties":false},"properties":{"detail":{"type":"string","additionalProperties":false,"nullable":true},"instance":{"type":"string","additionalProperties":false,"nullable":true},"status":{"type":"integer","format":"int32","additionalProperties":false,"nullable":true},"title":{"type":"string","additionalProperties":false,"nullable":true},"type":{"type":"string","additionalProperties":false,"nullable":true}}},"Products.ProductChannelMetadataModel":{"type":"object","additionalProperties":false,"properties":{"channel_id":{"type":"integer","format":"int64","additionalProperties":false},"channel_name":{"type":"string","additionalProperties":false,"nullable":true},"currency":{"type":"string","additionalProperties":false,"nullable":true},"id":{"type":"integer","format":"int64","additionalProperties":false,"nullable":true},"is_inventory_sync_enabled":{"type":"boolean","additionalProperties":false},"legacy_product_id":{"type":"integer","format":"int64","additionalProperties":false,"nullable":true},"platform":{"type":"string","additionalProperties":false,"nullable":true},"platform_identifier":{"type":"string","additionalProperties":false,"nullable":true},"platform_inventory_item_id":{"type":"string","additionalProperties":false,"nullable":true},"price":{"type":"number","format":"double","additionalProperties":false},"seller_sku":{"type":"string","additionalProperties":false,"nullable":true}}},"Products.ProductViewModel":{"type":"object","additionalProperties":false,"properties":{"category":{"additionalProperties":false,"$ref":"#/components/schemas/Products.EnumViewModel"},"created_on":{"type":"string","format":"date-time","additionalProperties":false},"id":{"type":"integer","format":"int64","additionalProperties":false},"name":{"type":"string","additionalProperties":false,"nullable":true},"sub_category":{"additionalProperties":false,"$ref":"#/components/schemas/Products.EnumViewModel"},"taxonomy":{"additionalProperties":false,"$ref":"#/components/schemas/Products.TaxonomyInformationViewModel"},"type":{"type":"string","additionalProperties":false,"nullable":true},"updated_on":{"type":"string","format":"date-time","additionalProperties":false,"nullable":true},"user_id":{"type":"integer","format":"int64","additionalProperties":false},"variants":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Products.VariantViewModel"},"nullable":true}}},"Products.ProductViewModelPagedResponse":{"type":"object","additionalProperties":false,"properties":{"first":{"type":"string","additionalProperties":false,"nullable":true},"items":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Products.ProductViewModel"},"nullable":true},"last":{"type":"string","additionalProperties":false,"nullable":true},"next":{"type":"string","additionalProperties":false,"nullable":true},"prev":{"type":"string","additionalProperties":false,"nullable":true}}},"Products.ProductViewModelV5":{"type":"object","additionalProperties":false,"properties":{"created_on":{"type":"string","format":"date-time","additionalProperties":false},"id":{"type":"integer","format":"int64","additionalProperties":false},"name":{"type":"string","additionalProperties":false,"nullable":true},"taxonomy":{"additionalProperties":false,"$ref":"#/components/schemas/Products.TaxonomyInformationViewModel"},"type":{"type":"string","additionalProperties":false,"nullable":true},"updated_on":{"type":"string","format":"date-time","additionalProperties":false,"nullable":true},"user_id":{"type":"integer","format":"int64","additionalProperties":false},"variants":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Products.VariantViewModelV5"},"nullable":true}}},"Products.ProductViewModelV5PagedResponse":{"type":"object","additionalProperties":false,"properties":{"first":{"type":"string","additionalProperties":false,"nullable":true},"items":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Products.ProductViewModelV5"},"nullable":true},"last":{"type":"string","additionalProperties":false,"nullable":true},"next":{"type":"string","additionalProperties":false,"nullable":true},"prev":{"type":"string","additionalProperties":false,"nullable":true}}},"Products.Put.Api.V2.Variant.VariantId.Channel.Metadata.ChannelMetadataId.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},"Products.Put.Api.V2.Variant.VariantId.Channel.Metadata.ChannelMetadataId.ChannelMetadataId.Integer":{"type":"integer","format":"int64","additionalProperties":false},"Products.Put.Api.V2.Variant.VariantId.Channel.Metadata.ChannelMetadataId.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails":{"additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.ProblemDetails"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.HttpValidationProblemDetails"}]},"Products.Put.Api.V2.Variant.VariantId.Channel.Metadata.ChannelMetadataId.Request.OneOf.AmazonChannelMetadataRequestModel.BaseChannelMetadataRequestModel.BigCommerceChannelMetadataRequestModel.ShopifyChannelMetadataRequestModel":{"additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.AmazonChannelMetadataRequestModel"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.BaseChannelMetadataRequestModel"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.BigCommerceChannelMetadataRequestModel"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.ShopifyChannelMetadataRequestModel"}]},"Products.Put.Api.V2.Variant.VariantId.Channel.Metadata.ChannelMetadataId.VariantId.Integer":{"type":"integer","format":"int64","additionalProperties":false},"Products.Put.Api.V5.Variant.VariantId.Channel.Metadata.ChannelMetadataId.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},"Products.Put.Api.V5.Variant.VariantId.Channel.Metadata.ChannelMetadataId.ChannelMetadataId.Integer":{"type":"integer","format":"int64","additionalProperties":false},"Products.Put.Api.V5.Variant.VariantId.Channel.Metadata.ChannelMetadataId.Not.Found.OneOf.ProblemDetails.HttpValidationProblemDetails":{"additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.ProblemDetails"},{"additionalProperties":false,"$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"},"additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.AmazonChannelMetadataRequestModel"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.BaseChannelMetadataRequestModel"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.BigCommerceChannelMetadataRequestModel"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.ShopifyChannelMetadataRequestModel"}]},"Products.Put.Api.V5.Variant.VariantId.Channel.Metadata.ChannelMetadataId.VariantId.Integer":{"type":"integer","format":"int64","additionalProperties":false},"Products.ReturnPreferencesRequestModel":{"type":"object","additionalProperties":false,"properties":{"backup_action_id":{"type":"integer","format":"int32","additionalProperties":false,"nullable":true},"instructions":{"type":"string","additionalProperties":false,"nullable":true},"primary_action_id":{"type":"integer","format":"int32","additionalProperties":false},"return_to_sender_backup_action_id":{"type":"integer","format":"int32","additionalProperties":false,"nullable":true},"return_to_sender_primary_action_id":{"type":"integer","format":"int32","additionalProperties":false,"nullable":true}}},"Products.ReturnPreferencesViewModel":{"type":"object","additionalProperties":false,"properties":{"backup_action":{"additionalProperties":false,"$ref":"#/components/schemas/Products.EnumViewModel"},"instructions":{"type":"string","additionalProperties":false,"nullable":true},"primary_action":{"additionalProperties":false,"$ref":"#/components/schemas/Products.EnumViewModel"},"return_to_sender_backup_action":{"additionalProperties":false,"$ref":"#/components/schemas/Products.EnumViewModel"},"return_to_sender_primary_action":{"additionalProperties":false,"$ref":"#/components/schemas/Products.EnumViewModel"}}},"Products.ReviewsPendingType":{"type":"integer","format":"int32","additionalProperties":false,"enum":[0,1,2,3,4]},"Products.SerialScanRequestModel":{"type":"object","additionalProperties":false,"properties":{"exact_character_length":{"type":"integer","format":"int32","additionalProperties":false,"nullable":true},"is_enabled":{"type":"boolean","additionalProperties":false},"prefix":{"type":"string","additionalProperties":false,"nullable":true},"suffix":{"type":"string","additionalProperties":false,"nullable":true}}},"Products.SerialScanViewModel":{"type":"object","additionalProperties":false,"properties":{"exact_character_length":{"type":"integer","format":"int32","additionalProperties":false,"nullable":true},"is_enabled":{"type":"boolean","additionalProperties":false},"prefix":{"type":"string","additionalProperties":false,"nullable":true},"suffix":{"type":"string","additionalProperties":false,"nullable":true}}},"Products.ShopifyChannelMetadataRequestModel":{"type":"object","description":"Shopify Sales Channel Information","additionalProperties":false,"properties":{"platform":{"type":"string","readOnly":true,"additionalProperties":false,"nullable":true}},"allOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.BaseChannelMetadataRequestModel"}]},"Products.ShopifyChannelMetadataViewModel":{"type":"object","additionalProperties":false,"allOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.ChannelMetadataViewModel"}]},"Products.ShopifyProductChannelMetadataModel":{"type":"object","additionalProperties":false,"allOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.BaseProductChannelMetadataModel"}]},"Products.TaxonomyInformationViewModel":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int32","additionalProperties":false,"nullable":true},"name":{"type":"string","additionalProperties":false,"nullable":true},"parent_id":{"type":"integer","format":"int32","additionalProperties":false,"nullable":true},"parent_name":{"type":"string","additionalProperties":false,"nullable":true},"path":{"type":"string","additionalProperties":false,"nullable":true}}},"Products.TaxonomyViewModel":{"type":"object","additionalProperties":false,"properties":{"children":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Products.ChildTaxonomyViewModel"},"nullable":true},"parent":{"additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.BaseTaxonomyViewModel"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.ChildTaxonomyViewModel"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.TaxonomyViewModel"}],"nullable":true}},"allOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.BaseTaxonomyViewModel"}]},"Products.TaxonomyViewModelArray":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Products.TaxonomyViewModel"}},"Products.UpdateProductRequestModelV3":{"type":"object","description":"The product to update","additionalProperties":false,"properties":{"variants":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Products.UpdateProductVariantRequestModelV3"},"nullable":true}},"allOf":[{"additionalProperties":false,"$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}]},"additionalProperties":false,"properties":{"id":{"type":"integer","description":"Unique reference ID for the product","format":"int64","additionalProperties":false},"variants":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Products.UpdateProductVariantRequestModelV5"},"nullable":true}},"allOf":[{"additionalProperties":false,"$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},"additionalProperties":false,"properties":{"barcodes":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Products.BarcodeModel"},"nullable":true},"id":{"type":"integer","format":"int64","additionalProperties":false}},"allOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.BaseProductVariantModel"}]},"Products.UpdateProductVariantRequestModel":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int64","additionalProperties":false}},"allOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.BaseProductVariantRequestModel"}]},"Products.UpdateProductVariantRequestModelV3":{"type":"object","additionalProperties":false,"properties":{"barcode_sticker_url":{"type":"string","additionalProperties":false,"nullable":true}},"allOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.UpdateProductVariantRequestModel"}]},"Products.UpdateProductVariantRequestModelV5":{"type":"object","additionalProperties":false,"properties":{"barcodes":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Products.BarcodeRequestModel"},"nullable":true},"id":{"type":"integer","format":"int64","additionalProperties":false}},"allOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.BaseProductVariantRequestModel"}]},"Products.VariantStatus":{"type":"integer","format":"int32","additionalProperties":false,"enum":[1,2,3]},"Products.VariantToMigrate":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int64","additionalProperties":false},"name":{"type":"string","additionalProperties":false,"nullable":true}}},"Products.VariantViewModel":{"type":"object","additionalProperties":false,"properties":{"barcode":{"type":"string","additionalProperties":false,"nullable":true},"barcode_sticker_url":{"type":"string","additionalProperties":false,"nullable":true},"channel_metadata":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.ChannelMetadataViewModel"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.AmazonChannelMetadataViewModel"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.BigCommerceChannelMetadataViewModel"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.ShopifyChannelMetadataViewModel"}]},"nullable":true}},"allOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.VariantViewModelBase"}]},"Products.VariantViewModelArray":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Products.VariantViewModel"}},"Products.VariantViewModelBase":{"type":"object","additionalProperties":false,"properties":{"additional_hazmat_attributes":{"additionalProperties":false,"$ref":"#/components/schemas/Products.AdditionalHazmatAttributesViewModel"},"associated_bundles":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Products.AssociatedBundlesViewModel"},"nullable":true},"bundle_definition":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Products.BundleDefinitionViewModel"},"nullable":true},"created_on":{"type":"string","format":"date-time","additionalProperties":false},"customs":{"additionalProperties":false,"$ref":"#/components/schemas/Products.CustomsViewModel"},"dimension":{"additionalProperties":false,"$ref":"#/components/schemas/Products.DimensionViewModel"},"fulfillment_settings":{"additionalProperties":false,"$ref":"#/components/schemas/Products.FulfillmentSettingsViewModel"},"gtin":{"type":"string","additionalProperties":false,"nullable":true},"id":{"type":"integer","format":"int64","additionalProperties":false},"inventory":{"additionalProperties":false,"$ref":"#/components/schemas/Products.InventoryViewModel"},"is_digital":{"type":"boolean","additionalProperties":false},"is_image_uploaded":{"type":"boolean","additionalProperties":false},"lot_information":{"additionalProperties":false,"$ref":"#/components/schemas/Products.LotInformationViewModel"},"merge_children":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Products.MergedChildrenViewModel"},"nullable":true},"name":{"type":"string","additionalProperties":false,"nullable":true},"packaging_material_type":{"additionalProperties":false,"$ref":"#/components/schemas/Products.EnumViewModel"},"packaging_requirement":{"additionalProperties":false,"$ref":"#/components/schemas/Products.EnumViewModel"},"return_preferences":{"additionalProperties":false,"$ref":"#/components/schemas/Products.ReturnPreferencesViewModel"},"reviews_pending":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false},"nullable":true},"sku":{"type":"string","additionalProperties":false,"nullable":true},"status":{"type":"string","additionalProperties":false,"nullable":true},"upc":{"type":"string","additionalProperties":false,"nullable":true},"updated_on":{"type":"string","format":"date-time","additionalProperties":false,"nullable":true},"weight":{"additionalProperties":false,"$ref":"#/components/schemas/Products.WeightViewModel"}}},"Products.VariantViewModelV5":{"type":"object","additionalProperties":false,"properties":{"barcodes":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Products.BarcodeViewModel"},"nullable":true},"channel_metadata":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.ChannelMetadataViewModel"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.AmazonChannelMetadataViewModel"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.BigCommerceChannelMetadataViewModel"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.ShopifyChannelMetadataViewModel"}]},"nullable":true}},"allOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.VariantViewModelBase"}]},"Products.VariantViewModelV5Array":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Products.VariantViewModelV5"}},"Products.WeightViewModel":{"type":"object","additionalProperties":false,"properties":{"unit":{"type":"string","additionalProperties":false,"nullable":true},"weight":{"type":"number","format":"double","additionalProperties":false}}},"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","additionalProperties":false,"nullable":true},"address2":{"type":"string","description":"Address line two of the fulfillment center","example":"Suite 100","additionalProperties":false,"nullable":true},"city":{"type":"string","description":"City the fulfillment center is located in","example":"Cicero","additionalProperties":false,"nullable":true},"country":{"type":"string","description":"Country the fulfillment center is located in","example":"USA","additionalProperties":false,"nullable":true},"email":{"type":"string","description":"Email contact for the fulfillment center","example":"example@example.com","additionalProperties":false,"nullable":true},"id":{"type":"integer","description":"Unique identifier of the fulfillment center","format":"int32","additionalProperties":false},"name":{"type":"string","description":"Name of the fulfillment center","example":"Cicero (IL)","additionalProperties":false,"nullable":true},"phone_number":{"type":"string","description":"Phone number contact for the fulfillment center","example":"555-555-5555","additionalProperties":false,"nullable":true},"state":{"type":"string","description":"State the fulfillment center is located in","example":"IL","additionalProperties":false,"nullable":true},"timezone":{"type":"string","description":"Timezone the fulfillment center is located in","example":"Central Standard Time","additionalProperties":false,"nullable":true},"zip_code":{"type":"string","description":"Postal code of the fulfillment center","example":"60804","additionalProperties":false,"nullable":true}}},"Receiving.PackageType":{"type":"string","additionalProperties":false,"enum":["Package","Pallet","FloorLoadedContainer"]},"Receiving.PackingType":{"type":"string","additionalProperties":false,"enum":["EverythingInOneBox","OneSkuPerBox","MultipleSkuPerBox"]},"Receiving.Post.2.0.Receiving.Set.External.Sync.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},"Receiving.ProblemDetails":{"type":"object","additionalProperties":{"additionalProperties":false},"properties":{"detail":{"type":"string","additionalProperties":false,"nullable":true},"instance":{"type":"string","additionalProperties":false,"nullable":true},"status":{"type":"integer","format":"int32","additionalProperties":false,"nullable":true},"title":{"type":"string","additionalProperties":false,"nullable":true},"type":{"type":"string","additionalProperties":false,"nullable":true}}},"Receiving.Put.Api.Receiving.Id.Tag.Authorization.String":{"type":"string","additionalProperties":false},"Receiving.Put.Api.Receiving.Id.Tag.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},"Receiving.Put.Api.Receiving.Id.Tag.Id.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Receiving.Put.Api.Receiving.Id.Tag.Not.Found.Object":{"type":"object","additionalProperties":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},"Receiving.ReceivingStatus":{"type":"string","additionalProperties":false,"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,"additionalProperties":false},"value":{"type":"string","maxLength":500,"minLength":1,"additionalProperties":false}}},"Receiving.UpdateExternalSyncModel":{"type":"object","example":{"ids":[0],"is_external_sync":true},"additionalProperties":false,"properties":{"ids":{"type":"array","additionalProperties":false,"items":{"type":"integer","format":"int32","additionalProperties":false},"nullable":true},"is_external_sync":{"type":"boolean","additionalProperties":false}}},"Receiving.UpdateReceivingTagsRequest":{"type":"object","example":{"data":[{"name":"string","value":"string"}]},"additionalProperties":false,"required":["data"],"properties":{"data":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Receiving.TagModel"}}}},"Receiving.UpdateReceivingTagsResponse":{"type":"object","additionalProperties":false,"properties":{"items":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Receiving.TagModel"},"nullable":true},"total_records":{"type":"integer","format":"int32","additionalProperties":false}}},"Receiving.V2.InventoryQuantityViewModel":{"type":"object","additionalProperties":false,"properties":{"expected_quantity":{"type":"integer","description":"Quantity of the inventory item submitted in the WRO","format":"int32","additionalProperties":false},"inventory_id":{"type":"integer","description":"ID of the inventory item","format":"int32","additionalProperties":false},"received_quantity":{"type":"integer","description":"Quantity of the inventory item received by the warehouse","format":"int32","additionalProperties":false},"sku":{"type":"string","description":"Sku of the inventory item","additionalProperties":false,"nullable":true},"stowed_quantity":{"type":"integer","description":"Quantity of the inventory item stowed by the warehouse","format":"int32","additionalProperties":false}}},"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","additionalProperties":false,"nullable":true},"box_packaging_type":{"additionalProperties":false,"$ref":"#/components/schemas/Receiving.PackingType"},"expected_arrival_date":{"type":"string","description":"Expected date that all packages will have arrived","format":"date-time","additionalProperties":false},"external_sync_timestamp":{"type":"string","description":"The timestamp in UTC when a 3rd party integrator has set in our system","format":"date-time","additionalProperties":false,"nullable":true},"fulfillment_center":{"additionalProperties":false,"$ref":"#/components/schemas/Receiving.FulfillmentCenterViewModel"},"id":{"type":"integer","description":"Unique id of the warehouse receiving order","format":"int32","additionalProperties":false},"insert_date":{"type":"string","description":"Insert date of the receiving order","format":"date-time","additionalProperties":false},"inventory_quantities":{"type":"array","description":"Inventory items and quantities within the WRO","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Receiving.V2.InventoryQuantityViewModel"},"nullable":true},"last_updated_date":{"type":"string","description":"Last date the receiving order was updated","format":"date-time","additionalProperties":false},"package_type":{"additionalProperties":false,"$ref":"#/components/schemas/Receiving.PackageType"},"purchase_order_number":{"type":"string","description":"Purchase order number for a receiving order","additionalProperties":false,"nullable":true},"status":{"additionalProperties":false,"$ref":"#/components/schemas/Receiving.ReceivingStatus"}}}},"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"}}},"description":"OAuth2 authentication using JWT tokens"}}}}