shipbob-node-sdk 0.0.16 → 0.0.18

package/openapi-2026-01.json

@@ -0,0 +1 @@
+{"openapi":"3.0.0","x-mcp":{"enabled":true},"info":{"title":"ShipBob Developer API (2026-01)","version":"2026-01"},"servers":[{"url":"https://api.shipbob.com"},{"url":"https://sandbox-api.shipbob.com"}],"paths":{"/2026-01/inventory-level":{"get":{"summary":"Get All Inventory Levels","description":"Retrieves current inventory levels across all locations. Returns available, on-hand, committed, and other quantity types. Supports filtering by inventory IDs and product attributes.","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":["Inventory"]}},"/2026-01/inventory-level/{inventoryId}":{"get":{"summary":"Get Inventory Levels","description":"Retrieves the aggregated inventory levels for a specific inventory item across all locations, including available, on-hand, committed, and other quantity types.","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":["Inventory"]}},"/2026-01/inventory-level/locations":{"get":{"summary":"Get All Inventory Levels Grouped By Fulfillment Center","description":"Retrieves inventory levels for all inventory items grouped by fulfillment center location. Supports filtering by location type, location ID, and various product attributes.","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":["Inventory"]}},"/2026-01/inventory/{inventoryId}":{"get":{"summary":"Get Inventory","description":"Retrieves detailed information about a specific inventory item by its ID, including product details, variant information, and associated metadata.","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":["Inventory"]}},"/2026-01/inventory-level/{inventoryId}/lots":{"get":{"summary":"Get Inventory Levels Grouped By Lot","description":"Retrieves inventory levels for a specific inventory item broken down by lot number. Useful for tracking inventory by manufacturing lot, expiration date, or batch information.","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":["Inventory"]}},"/2026-01/inventory-level/lots":{"get":{"summary":"Get All Inventory Levels Grouped By Lot","description":"Retrieves inventory levels for all inventory items grouped by lot number. Enables tracking of inventory across multiple lots, including expiration dates and manufacturing batch information.","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":["Inventory"]}},"/2026-01/inventory-level/{inventoryId}/locations":{"get":{"summary":"Get Inventory Levels Grouped By Fulfillment Center","description":"Retrieves inventory levels for a specific inventory item broken down by fulfillment center location. Shows quantity breakdowns for each location where the inventory is stored.","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":["Inventory"]}},"/2026-01/inventory":{"get":{"summary":"Get All Inventories","description":"Retrieves a paginated list of all inventory items. Supports filtering by active status, tags, and various product attributes. Use query parameters to search and filter results.","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":["Inventory"]}},"/2026-01/return/{id}":{"put":{"summary":"Edit Return Order\n","description":"Updates an existing return using the provided request body and returns the updated return payload.\n","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/Returns.PublicReturnV1Dto"},"example":{"channel":{"id":0,"name":"string"},"completed_date":"2019-08-24T14:15:22Z","customer_name":"string","fulfillment_center":{"id":0,"name":"string"},"id":0,"insert_date":"2019-08-24T14:15:22Z","inventory":[{"action_requested":{"action":"string","action_type":"string","instructions":"string"},"action_taken":[{"action":"string","action_reason":"string","image_url":"http://example.com","quantity_processed":0}],"id":0,"name":"string","quantity":0}],"invoice_amount":0.1,"original_shipment_id":0,"reference_id":"string","return_type":"string","status":"string","store_order_id":"string","tracking_number":"string","transactions":[{"amount":0.1,"transaction_type":"string"}]}}}},"401":{"description":"Authorization missing or invalid"},"403":{"description":"The provided credentials are not authorized to access this resource"},"404":{"description":"Not Found"},"422":{"description":"Client Error","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Returns.ApiError"},"example":{"details":null,"errors":["string"],"message":"string","stack_trace":"string"}}}}},"requestBody":{"x-name":"returns.CreateReturnRequest","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Returns.CreateReturnRequest"}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Returns"]},"get":{"summary":"Get Return Order\n","description":"Retrieves the complete details of a specific return order by its unique ID. Use this to view return status, inventory items, transactions, and processing history.\n","parameters":[{"name":"id","in":"path","required":true,"description":"The Id of the Return\n","schema":{"type":"string","format":"int32","additionalProperties":false}},{"name":"shipbob_channel_id","in":"header","description":"Channel Id for Operation\n","schema":{"type":"string","format":"int32","additionalProperties":false}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Returns.PublicReturnDto"},"example":{"arrived_date":"2019-08-24T14:15:22Z","awaiting_arrival_date":"2019-08-24T14:15:22Z","cancelled_date":"2019-08-24T14:15:22Z","channel":{"id":0,"name":"string"},"completed_date":"2019-08-24T14:15:22Z","customer_name":"string","fulfillment_center":{"id":0,"name":"string"},"id":0,"insert_date":"2019-08-24T14:15:22Z","inventory":[{"action_requested":{"action":"string","action_type":"string","instructions":"string"},"action_taken":[{"action":"string","action_reason":"string","image_url":"http://example.com","quantity_processed":0}],"barcodes":["string"],"id":0,"lot_information":{"expiration":"2019-08-24T14:15:22Z","minimumShelfLife":0,"number":"string"},"name":"string","quantity":0,"sku":"string"}],"invoice":{"amount":0.1,"currency_code":"string"},"original_shipment_id":0,"processing_date":"2019-08-24T14:15:22Z","reference_id":"string","return_type":"string","shipment_tracking_number":"string","status":"string","status_history":[{"status":"string","timestamp":"2019-08-24T14:15:22Z"}],"store_order_id":"string","tracking_number":"string","transactions":[{"amount":0.1,"transaction_type":"string"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Returns.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"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Returns.ProblemDetails"},"example":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Returns"]}},"/2026-01/taxonomy/{id}/parent":{"get":{"summary":"Get Taxonomy Parent","description":"Retrieves the parent taxonomy node for a given taxonomy ID.","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"]}},"/2026-01/product/{productId}:moveVariants":{"post":{"summary":"Move Variants Between Products","description":"Moves variants from their current product to the target product specified in the path. Provide an array of variant IDs to move.","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,"container_type":"string","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"]}},"/2026-01/taxonomy/{id}":{"get":{"summary":"Get Taxonomy by ID","description":"Retrieves a specific taxonomy node and its details by taxonomy ID.","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"]}},"/2026-01/taxonomy":{"get":{"summary":"Get Taxonomies","description":"Retrieves all available product taxonomies for categorizing products.","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"]}},"/2026-01/variant/{variantId}:convertToBundle":{"post":{"summary":"Convert Variant to Bundle","description":"Converts an existing product variant into a bundle product. Provide the bundle definition specifying which variants and quantities make up the bundle.","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,"container_type":"string","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"]}},"/2026-01/product/{productId}":{"get":{"summary":"Get Product","description":"Retrieves a product with all its variants and details.","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,"container_type":"string","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"]},"patch":{"summary":"Update Product","description":"Updates a product. Supports partial updates - only the fields provided will be updated. When updating variants through this endpoint, you must include the variant ID.","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,"container_type":"string","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"]},"delete":{"summary":"Delete Product Bundle","description":"Deletes a bundle product by ID. Delete operation not allowed for non-bundles.","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"]}},"/2026-01/product/{productId}/variants":{"get":{"summary":"Get Product Variants","description":"Retrieves all variants for a specific product.","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,"container_type":"string","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":"Add Product Variants","description":"Adds new variants to an existing product. The request body must be an array of variant objects, each requiring a unique SKU.","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,"container_type":"string","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"]},"patch":{"summary":"Update Product Variants","description":"Updates one or more product variants. The request body must be an array of variant objects. Each variant must include the variant ID, and only the fields provided will be updated.","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,"container_type":"string","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"]}},"/2026-01/packaging-requirement":{"get":{"summary":"Get Packaging Requirement","description":"Retrieves all available packaging requirements that can be assigned to a product.","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"]}},"/2026-01/product":{"post":{"summary":"Create Product","description":"Creates a new product with one or more variants. Requires a product name and at least one variant with a unique SKU.","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,"container_type":"string","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"]},"get":{"summary":"Get Products","description":"Retrieves a paginated list of products. Supports filtering by search term, barcode, SKU, status, and other criteria.","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":"Barcodes","in":"query","description":"Barcodes Associated with variant\n","schema":{"type":"string","additionalProperties":false}},{"name":"CategoryIds","in":"query","description":"List of Category Ids associated with product\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}},{"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}},{"name":"IsInventorySyncEnabled","in":"query","description":"Looks for Products variants by their IsInventorySyncEnabled is true\n","schema":{"type":"string","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}},{"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}},{"name":"ProductId","in":"query","description":"Looks for Products with an assigned Id\n","schema":{"type":"string","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}},{"name":"SalesChannel","in":"query","description":"Looks for Products variants assigned to a platform/sales channel \n","schema":{"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}},{"name":"VariantId","in":"query","description":"Looks for products that contain a variant with the given ID\n","schema":{"type":"string","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,"container_type":"string","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"]}},"/2026-01/product:moveVariants":{"post":{"summary":"Move Variants to New Product","description":"Creates a new product and moves existing variants from their current products into it. Provide the new product details and variant IDs.","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,"container_type":"string","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"]}},"/2026-01/variant/{variantId}:merge":{"post":{"summary":"Merge Variants","description":"Merges multiple product variants into a target variant. Provide an array of variant IDs to merge into the target variant specified in the path. Inventory from the merged variants will be consolidated into the target variant.","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,"container_type":"string","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"]}},"/2026-01/channel":{"get":{"summary":"Get Channels","description":"Retrieves a paginated list of channels that the authenticated user has access to based on the provided access token.\n","parameters":[{"name":"RecordsPerPage","in":"query","description":"The number of records to return per page. This parameter is used for pagination. If not provided, a default value will be used.","schema":{"type":"integer","default":50,"additionalProperties":false}},{"name":"Cursor","in":"query","description":"A cursor for pagination. This parameter is used to fetch the next set of results.","schema":{"type":"string","additionalProperties":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Channels.ChannelsV2ViewModel"},"example":{"items":[{"application_name":"SMA","id":128944,"name":"Privileged Access Token Wednesday, July 9, 2025","scopes":["pricing_read","fulfillments_write","returns_read","receiving_read","fulfillments_read","returns_write","locations_write","channels_read","webhooks_write","locations_read","orders_write","webhooks_read","inventory_read","billing_read","receiving_write","inventory_write","orders_read","products_read","products_write"]},{"application_name":"ShipBob","id":128943,"name":"ShipBob Default","scopes":["pricing_read","returns_read","receiving_read","fulfillments_read","channels_read","locations_read","webhooks_read","inventory_read","billing_read","orders_read","products_read"]}],"next":"/2026-01/channel?cursor=eyJJZCI6NzY4MzksIkN1cnNvclR5cGUiOjB5","prev":"/2026-01/channel?cursor=eyJJZCI6NzY4NDAsIkN1cnNvclR5cGUiOjF8"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Channels.ErrorResponse"},"example":{"property1":["string"],"property2":["string"]}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Channels"]}},"/2026-01/webhook":{"post":{"summary":"Create Subscription\n","description":"This endpoint creates a new webhook subscription.\n","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Webhooks.V2.Create.WebhookViewModelV2"},"example":{"created_at":"2019-08-24T14:15:22Z","description":"string","id":"12345","secret":"string","topics":["string"],"url":"string"}}}},"401":{"description":"No access right at this time"},"403":{"description":"No access"},"422":{"description":"Client Error","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Webhooks.UnprocessableEntityObjectResult"},"example":{"$type":"string","content_types":["string"],"declared_type":"string","formatters":[{}],"status_code":0,"value":{}}}}}},"requestBody":{"x-name":"webhooks.V2.CreateSubscriptionRequest","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Webhooks.V2.CreateSubscriptionRequest"}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Webhooks"]},"get":{"summary":"Get Subscriptions\n","description":"  This endpoint returns a list of webhook subscriptions.\n","parameters":[{"name":"RecordsPerPage","in":"query","description":"Number of webhooks returned per page in a paginated response.\n","schema":{"type":"number","format":"int32","maximum":250.0,"minimum":1.0,"additionalProperties":false}},{"name":"Cursor","in":"query","description":"[Optional] A pagination token used to retrieve the next or previous page of results. Omit to start at the first page.\n","schema":{"type":"string","additionalProperties":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Webhooks.GetWebhookResponse"},"example":{"items":[{"created_at":"2019-08-24T14:15:22Z","description":"string","enabled":true,"id":"12345","topics":["string"],"url":"string"}],"next":"string","prev":"string"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Webhooks.BadRequestObjectResult"},"example":{"$type":"string","content_types":["string"],"declared_type":"string","formatters":[{}],"status_code":0,"value":{}}}}},"401":{"description":"No access right at this time"},"403":{"description":"No access"}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Webhooks"]}},"/2026-01/webhook/{id}":{"delete":{"summary":"Delete Subscription\n","description":"  This endpoint deletes a webhook subscription.\n","parameters":[{"name":"id","in":"path","required":true,"description":"This is the id of the webhook subscription to delete\n","schema":{"type":"string","additionalProperties":false}}],"responses":{"204":{"description":"Success"},"401":{"description":"No access right at this time"},"403":{"description":"No access"}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Webhooks"]}},"/2026-01/invoices":{"get":{"summary":"Get Invoices","description":"Gets a paginated list of invoices, optionally filtered by invoice types and date range","parameters":[{"name":"Cursor","in":"query","description":"[Optional] A pagination token used to jump to first, last, next or previous pages. When supplied, it overrides all other filter parameters.\n","schema":{"type":"string","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.","schema":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false,"enum":["Shipping","WarehouseStorage","Inbound Fee","Return","AdditionalFee","Credits"]}}},{"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.InvoiceDtoCursorPagedResponseV3"},"example":{"first":"m8cUk/xJkbeYp2JJvL8oHqxL2hFuGz3qjqtkQ","items":[{"amount":0.01,"currency_code":"USD","invoice_date":"2019-08-24","invoice_id":12345,"invoice_type":"Shipping","running_balance":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"]}},"/2026-01/transaction-fees":{"get":{"summary":"Get Transaction Fees\n","description":"This endpoint returns a list of transaction fees\n","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Billing.TransactionFeeModelV3"},"example":{"fee_list":["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"]}},"/2026-01/invoices/{invoiceId}/transactions":{"get":{"summary":"Get Transactions by Invoice ID\n","description":"The unique identifier of the invoice whose transactions are to be retrieved","parameters":[{"name":"invoiceId","in":"path","required":true,"description":"The unique identifier of the invoice whose transactions are to be retrieved.\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.TransactionDtoCursorPagedResponseV3"},"example":{"first":"f8cUk/xJkbeYp2L8oHqxL2hFiGz3qjre","items":[{"additional_details":{"comment":"TestInvoice"},"amount":0.09,"charge_date":"2025-01-01","currency_code":"USD","fulfillment_center":"Altona VIC","invoice_date":"2025-01-01","invoice_id":12345,"invoice_type":"Shipping","invoiced_status":true,"reference_id":"12345","reference_type":"Shipment","taxes":[{"tax_amount":0.01,"tax_rate":10,"tax_type":"GST"}],"transaction_fee":"Shipping","transaction_id":"01AN4Z07BY79KA1307SR9X4MV3","transaction_type":"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"]}},"/2026-01/transactions:query":{"post":{"summary":"Search Transactions","description":"Search transactions with filters (date, invoice, fee type, etc.)","parameters":[{"name":"Cursor","in":"query","description":"[Optional] A pagination token used to jump to first, last, next or previous pages. When supplied, it overrides all other filter parameters.\n","schema":{"type":"string","additionalProperties":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Billing.TransactionDtoCursorPagedResponseV3"},"example":{"first":"f8cUk/xJkbeYp2L8oHqxL2hFiGz3qjre","items":[{"additional_details":{"comment":"TestInvoice"},"amount":0.09,"charge_date":"2025-01-01","currency_code":"USD","fulfillment_center":"Altona VIC","invoice_date":"2025-01-01","invoice_id":12345,"invoice_type":"Shipping","invoiced_status":true,"reference_id":"12345","reference_type":"Shipment","taxes":[{"tax_amount":0.01,"tax_rate":10,"tax_type":"GST"}],"transaction_fee":"Shipping","transaction_id":"01AN4Z07BY79KA1307SR9X4MV3","transaction_type":"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.TransactionRequestFilterV3","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.TransactionRequestFilterV3"}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Billing"]}},"/2026-01/return/{id}:cancel":{"post":{"summary":"Cancel Return order\n","description":"Cancels a return order for given return ID.\n","parameters":[{"name":"id","in":"path","required":true,"description":"Id of the return order\n","schema":{"type":"string","format":"int32","additionalProperties":false}}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Authorization missing or invalid"},"403":{"description":"The provided credentials are not authorized to access this resource"}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Returns"]}},"/2026-01/return":{"get":{"summary":"Get Return Orders\n","description":"Retrieves a paginated list of return orders with optional filters for IDs, statuses, dates, and other criteria. Use this to track all returns across your ShipBob account.\n","parameters":[{"name":"Ids","in":"query","description":"The IDs of the returns to fetch. Accepts a comma-separated list of return IDs (e.g., 123,456,789).\n","schema":{"type":"string","additionalProperties":false}},{"name":"ReferenceIds","in":"query","description":"Comma-separated list of return reference IDs (RMA numbers) to filter by.\n","schema":{"type":"string","additionalProperties":false}},{"name":"Status","in":"query","description":"Comma-separated list of return statuses to filter by (e.g., AwaitingArrival, Arrived, Processing, Completed, Cancelled).\n","schema":{"type":"string","additionalProperties":false}},{"name":"FulfillmentCenterIds","in":"query","description":"Comma-separated list of fulfillment center IDs to filter by.\n","schema":{"type":"string","additionalProperties":false}},{"name":"TrackingNumbers","in":"query","description":"Comma-separated list of tracking numbers to filter by.\n","schema":{"type":"string","additionalProperties":false}},{"name":"OriginalShipmentIds","in":"query","description":"Comma-separated list of original shipment IDs to filter by.\n","schema":{"type":"string","additionalProperties":false}},{"name":"InventoryIds","in":"query","description":"Comma-separated list of inventory IDs to filter by.\n","schema":{"type":"string","additionalProperties":false}},{"name":"StartDate","in":"query","description":"Filter returns created on or after this date (ISO 8601 format).\n","schema":{"type":"string","format":"date-time","additionalProperties":false}},{"name":"EndDate","in":"query","description":"Filter returns created on or before this date (ISO 8601 format).\n","schema":{"type":"string","format":"date-time","additionalProperties":false}},{"name":"ReturnTypes","in":"query","description":"Comma-separated list of return types to filter by (e.g., Regular, ReturnToSender).\n","schema":{"type":"string","additionalProperties":false}},{"name":"ReturnActions","in":"query","description":"Comma-separated list of return actions to filter by (e.g., Restock, Quarantine, Dispose).\n","schema":{"type":"string","additionalProperties":false}},{"name":"StoreOrderIds","in":"query","description":"Comma-separated list of store order IDs to filter by.\n","schema":{"type":"string","additionalProperties":false}},{"name":"Sortby","in":"query","description":"Field to sort results by.\n","schema":{"type":"string","additionalProperties":false}},{"name":"CompletedStartDate","in":"query","description":"Filter returns completed on or after this date (ISO 8601 format).\n","schema":{"type":"string","format":"date-time","additionalProperties":false}},{"name":"CompletedEndDate","in":"query","description":"Filter returns completed on or before this date (ISO 8601 format).\n","schema":{"type":"string","format":"date-time","additionalProperties":false}},{"name":"Cursor","in":"query","description":"Page number to retrieve. Used for pagination through result sets.\n","schema":{"type":"number","format":"int32","maximum":2147483647.0,"minimum":1.0,"additionalProperties":false}},{"name":"Limit","in":"query","description":"Maximum number of records to return per page.\n","schema":{"type":"number","format":"int32","additionalProperties":false}},{"name":"SortOrder","in":"query","description":"Sort order for results. Desc = newest to oldest, Asc = oldest to newest, Desc is default\n","schema":{"type":"string","additionalProperties":false,"enum":["Asc","Desc"]}},{"name":"shipbob_channel_id","in":"header","description":"Channel Id for operation\n","schema":{"type":"string","format":"int32","additionalProperties":false}}],"responses":{"200":{"description":"OK","headers":{"Page-Number":{"description":"Current page number\n","schema":{"type":"object","format":"","additionalProperties":false}},"Total-Pages":{"description":"Total pages\n","schema":{"type":"object","format":"","additionalProperties":false}},"Total-Count":{"description":"Total records\n","schema":{"type":"object","format":"","additionalProperties":false}},"Page-Size":{"description":"Page size\n","schema":{"type":"object","format":"","additionalProperties":false}}},"content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Returns.PublicReturnDtoPagedUrlResultDto"},"example":{"first":"http://example.com","items":[{"arrived_date":"2019-08-24T14:15:22Z","awaiting_arrival_date":"2019-08-24T14:15:22Z","cancelled_date":"2019-08-24T14:15:22Z","channel":{"id":0,"name":"string"},"completed_date":"2019-08-24T14:15:22Z","customer_name":"string","fulfillment_center":{"id":0,"name":"string"},"id":0,"insert_date":"2019-08-24T14:15:22Z","inventory":[{"action_requested":{"action":"string","action_type":"string","instructions":"string"},"action_taken":[{"action":"string","action_reason":"string","image_url":"http://example.com","quantity_processed":0}],"barcodes":["string"],"id":0,"lot_information":{"expiration":"2019-08-24T14:15:22Z","minimumShelfLife":0,"number":"string"},"name":"string","quantity":0,"sku":"string"}],"invoice":{"amount":0.1,"currency_code":"string"},"original_shipment_id":0,"processing_date":"2019-08-24T14:15:22Z","reference_id":"string","return_type":"string","shipment_tracking_number":"string","status":"string","status_history":[{"status":"string","timestamp":"2019-08-24T14:15:22Z"}],"store_order_id":"string","tracking_number":"string","transactions":[{"amount":0.1,"transaction_type":"string"}]}],"last":"http://example.com","next":"http://example.com","prev":"http://example.com"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Returns.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"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Returns.ProblemDetails"},"example":{"detail":"string","instance":"string","property1":null,"property2":null,"status":0,"title":"string","type":"string"}}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Returns"]},"post":{"summary":"Create Return Order\n","description":"Creates a new return order for a previously shipped order. Specify the original shipment, inventory items to return, and requested return actions.\n","parameters":[{"name":"shipbob_channel_id","in":"header","required":true,"description":"Channel Id for operation\n","schema":{"type":"string","format":"int32","additionalProperties":false}}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Returns.PublicReturnV1Dto"},"example":{"channel":{"id":0,"name":"string"},"completed_date":"2019-08-24T14:15:22Z","customer_name":"string","fulfillment_center":{"id":0,"name":"string"},"id":0,"insert_date":"2019-08-24T14:15:22Z","inventory":[{"action_requested":{"action":"string","action_type":"string","instructions":"string"},"action_taken":[{"action":"string","action_reason":"string","image_url":"http://example.com","quantity_processed":0}],"id":0,"name":"string","quantity":0}],"invoice_amount":0.1,"original_shipment_id":0,"reference_id":"string","return_type":"string","status":"string","store_order_id":"string","tracking_number":"string","transactions":[{"amount":0.1,"transaction_type":"string"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Returns.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":"Unprocessable Content","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Returns.ApiError"},"example":{"details":null,"errors":["string"],"message":"string","stackTrace":"string"}}}}},"requestBody":{"x-name":"returns.CreateReturnRequest","description":"The return order creation request containing return details, items, and configuration.","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Returns.CreateReturnRequest"}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Returns"]}},"/2026-01/location":{"get":{"summary":"Get Locations","description":"Retrieves physical locations across ShipBob's fulfillment network. An active location (`is_active=true`) is operational for fulfillment processes, including receiving inventory and processing returns. Access to locations varies: some are available to all merchants by default, while others require special approval. Use the `access_granted` parameter to determine if a location is available to the authenticated user, and `receiving_enabled` to confirm if the location accepts inventory.","parameters":[{"name":"IncludeInactive","in":"query","description":"Whether the inactive locations should be included or not\n","schema":{"type":"boolean","additionalProperties":false}},{"name":"ReceivingEnabled","in":"query","description":"Return all the receiving enabled locations\n","schema":{"type":"boolean","additionalProperties":false}},{"name":"AccessGranted","in":"query","description":"Return all the access granted locations\n","schema":{"type":"boolean","additionalProperties":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Locations.Get.1.0.Location.OK.OneOfArray"},"example":[{"abbreviation":"string","access_granted":true,"attributes":["string"],"id":0,"is_active":true,"is_receiving_enabled":true,"is_shipping_enabled":true,"name":"string","region":{"id":0,"name":"string"},"services":[{"address":{"address1":"string","address2":"string","city":"string","country":"string","email":"string","name":"string","phone_number":"string","state":"string","zip_code":"string"},"enabled":true,"service_type":"Receiving"}],"timezone":"string"}]}}},"401":{"description":"Authorization missing or invalid"},"403":{"description":"The provided credentials are not authorized to access this resource"}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Locations"]}},"/2026-01/shipping-method":{"get":{"summary":"Get Shipping Methods","description":"Retrieves all available shipping methods configured for your merchant account.","parameters":[{"name":"Page","in":"query","description":"Page of orders to get","schema":{"type":"number","format":"int32","maximum":2147483647.0,"minimum":0.0,"additionalProperties":false}},{"name":"Limit","in":"query","description":"Amount of records per page to request","schema":{"type":"number","format":"int32","maximum":250.0,"minimum":1.0,"additionalProperties":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.ShipMethodDetailViewModelArray"},"example":[{"active":true,"default":true,"id":0,"name":"string","service_level":{"id":0,"name":"string"}}]}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.Get.Api.Shippingmethod.Bad.Request.Object"},"example":{"property1":["string"],"property2":["string"]}}}},"401":{"description":"No access right at this time"},"403":{"description":"No access"},"422":{"description":"Client Error","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.Get.Api.Shippingmethod.Unprocessable.Entity.Object"},"example":{"property1":["string"],"property2":["string"]}}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Orders"]}},"/2026-01/shipment/{shipmentId}":{"get":{"summary":"Get Shipment","description":"Retrieves detailed information about a specific shipment by shipment ID, including shipment status, tracking information, fulfillment center location, and contained products.","parameters":[{"name":"shipmentId","in":"path","required":true,"description":"The shipment id to get","schema":{"type":"string","format":"int32","additionalProperties":false}},{"name":"shipbob_channel_id","in":"header","description":"Channel Id for Operation","schema":{"type":"string","format":"int32","additionalProperties":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.ShipmentViewModel"},"example":{"actual_fulfillment_date":"2019-08-24T14:15:22Z","created_date":"2019-08-24T14:15:22Z","delivery_date":"2019-08-24T14:15:22Z","estimated_fulfillment_date":"2019-08-24T14:15:22Z","estimated_fulfillment_date_status":"AwaitingInventoryAllocation","gift_message":"string","id":0,"insurance_value":0,"invoice_amount":0,"invoice_currency_code":"string","is_tracking_uploaded":true,"last_tracking_update_at":"2019-08-24T14:15:22Z","last_update_at":"2019-08-24T14:15:22Z","location":{"id":0,"name":"Cicero (IL)"},"measurements":{"depth_in":0,"length_in":0,"total_weight_oz":0,"width_in":0},"order_id":0,"package_material_type":"Unknown","parent_cartons":[{"barcode":"string","cartons":[{"barcode":"string","carton_details":[{"products":[{"id":0,"inventory_items":[{"expiration_date":"2019-08-24T14:15:22Z","id":0,"is_dangerous_goods":true,"lot":"22222","name":"Medium Blue T-Shirt","quantity":0,"quantity_committed":0,"serial_numbers":["string"]}],"name":"Medium Blue T-Shirt","reference_id":"TShirtBlueM","sku":"TShirtBlueM"}]}],"id":0,"measurements":{"depth_in":0.1,"length_in":0.1,"total_weight_oz":0.1,"width_in":0.1},"type":"Box or pallet"}],"measurements":{"depth_in":0.1,"length_in":0.1,"total_weight_oz":0.1,"width_in":0.1},"type":"Box or pallet"}],"products":[{"id":0,"inventory_items":[{"expiration_date":"2019-08-24T14:15:22Z","id":0,"is_dangerous_goods":true,"lot":"22222","name":"Medium Blue T-Shirt","quantity":0,"quantity_committed":0,"serial_numbers":["string"]}],"name":"Medium Blue T-Shirt","reference_id":"TShirtBlueM","sku":"TShirtBlueM"}],"recipient":{"address":{"address1":"100 Nowhere Blvd","address2":"Suite 100","city":"Gotham City","company_name":"Wayne Enterprises","country":"US","state":"NJ","zip_code":"07093"},"email":"john@example.com","full_name":"John Doe","name":"John Doe","phone_number":"555-555-5555"},"reference_id":"string","require_signature":true,"ship_option":"Standard","status":"None","status_details":[{"description":"string","exception_fulfillment_center_id":0,"extra_information":{"validation_messages":["string"]},"id":0,"inventory_id":0,"name":"string"}],"tracking":{"bol":"string","carrier":"USPS","carrier_service":"Priority","pro_number":"string","scac":"string","shipping_date":"2019-08-24T14:15:22Z","tracking_number":"860C8CDC8F0B4FC7AB69AC86C20539EC","tracking_url":"https://www.example.com/tracking?id=860C8CDC8F0B4FC7AB69AC86C20539EC"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.Get.Api.Shipment.ShipmentId.Bad.Request.Object"},"example":{"property1":["string"],"property2":["string"]}}}},"401":{"description":"No access right at this time"},"403":{"description":"No access"},"404":{"description":"Not Found"}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Orders"]}},"/2026-01/order/{orderId}/shipment/{shipmentId}/timeline":{"get":{"summary":"Get Shipment Status Timeline by Order ID and Shipment ID","description":"Retrieves a chronological timeline of shipment status updates by shipment ID, showing when each status change occurred and providing visibility into the fulfillment progress.","parameters":[{"name":"orderId","in":"path","required":true,"description":"The order id to get the shipment for","schema":{"type":"string","format":"int32","additionalProperties":false}},{"name":"shipmentId","in":"path","required":true,"description":"The shipment id to get","schema":{"type":"string","format":"int32","additionalProperties":false}},{"name":"shipbob_channel_id","in":"header","description":"Channel Id for Operation","schema":{"type":"string","format":"int32","additionalProperties":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.ShipmentLogViewModelArray"},"example":[{"log_type_id":0,"log_type_name":"string","log_type_text":"string","metadata":{"property1":"string","property2":"string"},"timestamp":"2019-08-24T14:15:22Z"}]}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.Timeline.Bad.Request.Object"},"example":{"property1":["string"],"property2":["string"]}}}},"401":{"description":"No access right at this time"},"403":{"description":"No access"},"404":{"description":"Not Found"}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Orders"]}},"/2026-01/shipment/{shipmentId}:cancel":{"post":{"summary":"Cancel Shipment","description":"Cancels a specific shipment by shipment ID. The shipment must not be picked, packed, or shipped to proceed with the cancellation.","parameters":[{"name":"shipmentId","in":"path","required":true,"description":"The shipment id to get","schema":{"type":"string","format":"int32","additionalProperties":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.ShipmentViewModel"},"example":{"actual_fulfillment_date":"2019-08-24T14:15:22Z","created_date":"2019-08-24T14:15:22Z","delivery_date":"2019-08-24T14:15:22Z","estimated_fulfillment_date":"2019-08-24T14:15:22Z","estimated_fulfillment_date_status":"AwaitingInventoryAllocation","gift_message":"string","id":0,"insurance_value":0,"invoice_amount":0,"invoice_currency_code":"string","is_tracking_uploaded":true,"last_tracking_update_at":"2019-08-24T14:15:22Z","last_update_at":"2019-08-24T14:15:22Z","location":{"id":0,"name":"Cicero (IL)"},"measurements":{"depth_in":0,"length_in":0,"total_weight_oz":0,"width_in":0},"order_id":0,"package_material_type":"Unknown","parent_cartons":[{"barcode":"string","cartons":[{"barcode":"string","carton_details":[{"products":[{"id":0,"inventory_items":[{"expiration_date":"2019-08-24T14:15:22Z","id":0,"is_dangerous_goods":true,"lot":"22222","name":"Medium Blue T-Shirt","quantity":0,"quantity_committed":0,"serial_numbers":["string"]}],"name":"Medium Blue T-Shirt","reference_id":"TShirtBlueM","sku":"TShirtBlueM"}]}],"id":0,"measurements":{"depth_in":0.1,"length_in":0.1,"total_weight_oz":0.1,"width_in":0.1},"type":"Box or pallet"}],"measurements":{"depth_in":0.1,"length_in":0.1,"total_weight_oz":0.1,"width_in":0.1},"type":"Box or pallet"}],"products":[{"id":0,"inventory_items":[{"expiration_date":"2019-08-24T14:15:22Z","id":0,"is_dangerous_goods":true,"lot":"22222","name":"Medium Blue T-Shirt","quantity":0,"quantity_committed":0,"serial_numbers":["string"]}],"name":"Medium Blue T-Shirt","reference_id":"TShirtBlueM","sku":"TShirtBlueM"}],"recipient":{"address":{"address1":"100 Nowhere Blvd","address2":"Suite 100","city":"Gotham City","company_name":"Wayne Enterprises","country":"US","state":"NJ","zip_code":"07093"},"email":"john@example.com","full_name":"John Doe","name":"John Doe","phone_number":"555-555-5555"},"reference_id":"string","require_signature":true,"ship_option":"Standard","status":"None","status_details":[{"description":"string","exception_fulfillment_center_id":0,"extra_information":{"validation_messages":["string"]},"id":0,"inventory_id":0,"name":"string"}],"tracking":{"bol":"string","carrier":"USPS","carrier_service":"Priority","pro_number":"string","scac":"string","shipping_date":"2019-08-24T14:15:22Z","tracking_number":"860C8CDC8F0B4FC7AB69AC86C20539EC","tracking_url":"https://www.example.com/tracking?id=860C8CDC8F0B4FC7AB69AC86C20539EC"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.Post.Api.Shipment.ShipmentId.Cancel.Bad.Request.Object"},"example":{"property1":["string"],"property2":["string"]}}}},"401":{"description":"No access right at this time"},"403":{"description":"No access"},"404":{"description":"Not Found"},"422":{"description":"Client Error","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.Post.Api.Shipment.ShipmentId.Cancel.Unprocessable.Entity.Object"},"example":{"property1":["string"],"property2":["string"]}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.Post.Api.Shipment.ShipmentId.Cancel.Internal.Server.Error.Object"},"example":{"property1":["string"],"property2":["string"]}}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Orders"]}},"/2026-01/order/{orderId}/shipment":{"get":{"summary":"Get All Shipments for Order","description":"Retrieves all shipments associated with a specific order, including shipment status, tracking information, and product details.","parameters":[{"name":"orderId","in":"path","required":true,"description":"The order id to get shipments for","schema":{"type":"string","format":"int32","additionalProperties":false}},{"name":"shipbob_channel_id","in":"header","description":"Channel Id for Operation","schema":{"type":"string","format":"int32","additionalProperties":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.Get.Api.Order.OrderId.Shipment.OK.OneOfArray"},"example":[{"actual_fulfillment_date":"2019-08-24T14:15:22Z","created_date":"2019-08-24T14:15:22Z","delivery_date":"2019-08-24T14:15:22Z","estimated_fulfillment_date":"2019-08-24T14:15:22Z","estimated_fulfillment_date_status":"AwaitingInventoryAllocation","gift_message":"string","id":0,"insurance_value":0,"invoice_amount":0,"invoice_currency_code":"string","is_tracking_uploaded":true,"last_tracking_update_at":"2019-08-24T14:15:22Z","last_update_at":"2019-08-24T14:15:22Z","location":{"id":0,"name":"Cicero (IL)"},"measurements":{"depth_in":0,"length_in":0,"total_weight_oz":0,"width_in":0},"order_id":0,"package_material_type":"Unknown","parent_cartons":[{"barcode":"string","cartons":[{"barcode":"string","carton_details":[{"products":[{"id":0,"inventory_items":[{"expiration_date":"2019-08-24T14:15:22Z","id":0,"is_dangerous_goods":true,"lot":"22222","name":"Medium Blue T-Shirt","quantity":0,"quantity_committed":0,"serial_numbers":["string"]}],"name":"Medium Blue T-Shirt","reference_id":"TShirtBlueM","sku":"TShirtBlueM"}]}],"id":0,"measurements":{"depth_in":0.1,"length_in":0.1,"total_weight_oz":0.1,"width_in":0.1},"type":"Box or pallet"}],"measurements":{"depth_in":0.1,"length_in":0.1,"total_weight_oz":0.1,"width_in":0.1},"type":"Box or pallet"}],"products":[{"id":0,"inventory_items":[{"expiration_date":"2019-08-24T14:15:22Z","id":0,"is_dangerous_goods":true,"lot":"22222","name":"Medium Blue T-Shirt","quantity":0,"quantity_committed":0,"serial_numbers":["string"]}],"name":"Medium Blue T-Shirt","reference_id":"TShirtBlueM","sku":"TShirtBlueM"}],"recipient":{"address":{"address1":"100 Nowhere Blvd","address2":"Suite 100","city":"Gotham City","company_name":"Wayne Enterprises","country":"US","state":"NJ","zip_code":"07093"},"email":"john@example.com","full_name":"John Doe","name":"John Doe","phone_number":"555-555-5555"},"reference_id":"string","require_signature":true,"ship_option":"Standard","status":"None","status_details":[{"description":"string","exception_fulfillment_center_id":0,"extra_information":{"validation_messages":["string"]},"id":0,"inventory_id":0,"name":"string"}],"tracking":{"bol":"string","carrier":"USPS","carrier_service":"Priority","pro_number":"string","scac":"string","shipping_date":"2019-08-24T14:15:22Z","tracking_number":"860C8CDC8F0B4FC7AB69AC86C20539EC","tracking_url":"https://www.example.com/tracking?id=860C8CDC8F0B4FC7AB69AC86C20539EC"}}]}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.Get.Api.Order.OrderId.Shipment.Bad.Request.Object"},"example":{"property1":["string"],"property2":["string"]}}}},"401":{"description":"No access right at this time"},"403":{"description":"No access"},"404":{"description":"Not Found"}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Orders"]}},"/2026-01/shipment:batchCancel":{"post":{"summary":"Batch Cancel Shipments","description":"Cancels multiple shipments in a single request. Shipments can only be cancelled if they are in a cancellable state (i.e. not picked, packed, or shipped yet).","parameters":[{"name":"shipbob_channel_id","in":"header","required":true,"description":"Channel ID for Operation","schema":{"type":"string","format":"int32","additionalProperties":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.CanceledShipmentsViewModel"},"example":{"results":[{"action":"Cancel","is_success":true,"reason":"string","shipment_id":0}]}}}},"401":{"description":"No access right at this time"},"403":{"description":"No access"},"422":{"description":"Client Error","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.Post.Api.Shipment.Cancelbulk.Unprocessable.Entity.Object"},"example":{"property1":["string"],"property2":["string"]}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.Post.Api.Shipment.Cancelbulk.Internal.Server.Error.Object"},"example":{"property1":["string"],"property2":["string"]}}}}},"requestBody":{"x-name":"orders.CancelShipmentsModel","description":"The shipment IDs to cancel","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.CancelShipmentsModel"}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Orders"]}},"/2026-01/order":{"get":{"summary":"Get Orders","description":"Retrieves a paginated list of orders from your ShipBob account with optional filters. All filter parameters use AND logic, meaning orders must match all provided criteria to be returned.","parameters":[{"name":"Page","in":"query","description":"Page of orders to get","schema":{"type":"number","format":"int32","maximum":2147483647.0,"minimum":1.0,"additionalProperties":false}},{"name":"Limit","in":"query","description":"Amount of orders per page to request","schema":{"type":"number","format":"int32","maximum":250.0,"minimum":1.0,"additionalProperties":false}},{"name":"IDs","in":"query","description":"order ids to filter by, comma separated <br /><strong>Example:</strong> ?IDs=1,2","schema":{"type":"string","additionalProperties":false,"items":{"type":"integer","format":"int32","additionalProperties":false}}},{"name":"ReferenceIds","in":"query","description":"Reference ids to filter by, comma separated <br /><strong>Example:</strong> ?ReferenceIds=Ref1,Ref2","schema":{"type":"string","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},{"name":"StartDate","in":"query","description":"Start date to filter orders inserted later than","schema":{"type":"string","format":"date-time","additionalProperties":false}},{"name":"EndDate","in":"query","description":"End date to filter orders inserted earlier than","schema":{"type":"string","format":"date-time","additionalProperties":false}},{"name":"SortOrder","in":"query","description":"Order to sort results in","schema":{"type":"string","additionalProperties":false}},{"name":"HasTracking","in":"query","description":"Has any portion of this order been assigned a tracking number","schema":{"type":"boolean","additionalProperties":false}},{"name":"LastUpdateStartDate","in":"query","description":"Start date to filter orders updated later than","schema":{"type":"string","format":"date-time","additionalProperties":false}},{"name":"LastUpdateEndDate","in":"query","description":"End date to filter orders updated later than","schema":{"type":"string","format":"date-time","additionalProperties":false}},{"name":"IsTrackingUploaded","in":"query","description":"Filter orders that their tracking information was fully uploaded","schema":{"type":"boolean","additionalProperties":false}},{"name":"LastTrackingUpdateStartDate","in":"query","description":"Start date to filter orders with tracking updates later than the supplied date. Will only return orders that have tracking information","schema":{"type":"string","format":"date-time","additionalProperties":false}},{"name":"LastTrackingUpdateEndDate","in":"query","description":"End date to filter orders updated later than the supplied date. Will only return orders that have tracking information","schema":{"type":"string","format":"date-time","additionalProperties":false}},{"name":"shipbob_channel_id","in":"header","description":"Channel Id for Operation","schema":{"type":"string","format":"int32","additionalProperties":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.OrderViewModelArray"},"example":[{"channel":{"id":0,"name":"ShipBobs-Shopify-Store"},"created_date":"2019-08-24T14:15:22Z","financials":{"total_price":0.1},"gift_message":"string","id":0,"order_number":"string","products":[{"external_line_id":0,"gtin":"string","id":0,"quantity":0,"quantity_unit_of_measure_code":"string","reference_id":"TShirtBlueM","sku":"TShirtBlueM","unit_price":0.1,"upc":"string"}],"purchase_date":"2019-08-24T14:15:22Z","recipient":{"address":{"address1":"100 Nowhere Blvd","address2":"Suite 100","city":"Gotham City","company_name":"Wayne Enterprises","country":"US","state":"NJ","zip_code":"07093"},"email":"john@example.com","name":"John Doe","phone_number":"555-555-5555"},"reference_id":"string","retailer_program_data":{"addresses":[{"address1":"100 Nowhere Blvd","address2":"Suite 100","city":"Gotham City","company_name":"Wayne Enterprises","country":"US","state":"NJ","type":"MarkFor","zip_code":"07093"}],"customer_ticket_number":"string","delivery_date":"2019-08-24T14:15:22Z","department":"string","doNotShipBeforeDate":"2019-08-24T14:15:22Z","mark_for_store":"string","purchase_order_number":"string","retailer_program_type":"string","shipByDate":"2019-08-24T14:15:22Z"},"shipments":[{"actual_fulfillment_date":"2019-08-24T14:15:22Z","created_date":"2019-08-24T14:15:22Z","delivery_date":"2019-08-24T14:15:22Z","estimated_fulfillment_date":"2019-08-24T14:15:22Z","estimated_fulfillment_date_status":"AwaitingInventoryAllocation","gift_message":"string","id":0,"insurance_value":0,"invoice_amount":0,"invoice_currency_code":"string","is_tracking_uploaded":true,"last_tracking_update_at":"2019-08-24T14:15:22Z","last_update_at":"2019-08-24T14:15:22Z","location":{"id":0,"name":"Cicero (IL)"},"measurements":{"depth_in":0,"length_in":0,"total_weight_oz":0,"width_in":0},"order_id":0,"package_material_type":"Unknown","parent_cartons":[{"barcode":"string","cartons":[{"barcode":"string","carton_details":[{"products":[{"id":0,"inventory_items":[{"expiration_date":"2019-08-24T14:15:22Z","id":0,"is_dangerous_goods":true,"lot":"22222","name":"Medium Blue T-Shirt","quantity":0,"quantity_committed":0,"serial_numbers":[null]}],"name":"Medium Blue T-Shirt","reference_id":"TShirtBlueM","sku":"TShirtBlueM"}]}],"id":0,"measurements":{"depth_in":0.1,"length_in":0.1,"total_weight_oz":0.1,"width_in":0.1},"type":"Box or pallet"}],"measurements":{"depth_in":0.1,"length_in":0.1,"total_weight_oz":0.1,"width_in":0.1},"type":"Box or pallet"}],"products":[{"id":0,"inventory_items":[{"expiration_date":"2019-08-24T14:15:22Z","id":0,"is_dangerous_goods":true,"lot":"22222","name":"Medium Blue T-Shirt","quantity":0,"quantity_committed":0,"serial_numbers":["string"]}],"name":"Medium Blue T-Shirt","reference_id":"TShirtBlueM","sku":"TShirtBlueM"}],"recipient":{"address":{"address1":"100 Nowhere Blvd","address2":"Suite 100","city":"Gotham City","company_name":"Wayne Enterprises","country":"US","state":"NJ","zip_code":"07093"},"email":"john@example.com","full_name":"John Doe","name":"John Doe","phone_number":"555-555-5555"},"reference_id":"string","require_signature":true,"ship_option":"Standard","status":"None","status_details":[{"description":"string","exception_fulfillment_center_id":0,"extra_information":{"validation_messages":["string"]},"id":0,"inventory_id":0,"name":"string"}],"tracking":{"bol":"string","carrier":"USPS","carrier_service":"Priority","pro_number":"string","scac":"string","shipping_date":"2019-08-24T14:15:22Z","tracking_number":"860C8CDC8F0B4FC7AB69AC86C20539EC","tracking_url":"https://www.example.com/tracking?id=860C8CDC8F0B4FC7AB69AC86C20539EC"}}],"shipping_method":"Free 2-day Shipping","shipping_terms":{"carrier_type":"Parcel","payment_term":"Collect"},"status":"Processing","tags":[{"name":"Handling instructions","value":"Fragile"}],"type":"DTC"}]}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.Get.Api.Order.Bad.Request.Object"},"example":{"property1":["string"],"property2":["string"]}}}},"401":{"description":"No access right at this time"},"403":{"description":"No access"}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Orders"]},"post":{"summary":"Create Order","description":"Creates a new order in ShipBob’s system that will be queued for fulfillment. Orders can be created using either product reference IDs (SKUs) or ShipBob product IDs, with reference IDs being the recommended approach.","parameters":[{"name":"shipbob_channel_id","in":"header","required":true,"description":"Channel Id for Operation","schema":{"type":"string","format":"int32","additionalProperties":false}}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.OrderViewModel"},"example":{"channel":{"id":0,"name":"ShipBobs-Shopify-Store"},"created_date":"2019-08-24T14:15:22Z","financials":{"total_price":0.1},"gift_message":"string","id":0,"order_number":"string","products":[{"external_line_id":0,"gtin":"string","id":0,"quantity":0,"quantity_unit_of_measure_code":"string","reference_id":"TShirtBlueM","sku":"TShirtBlueM","unit_price":0.1,"upc":"string"}],"purchase_date":"2019-08-24T14:15:22Z","recipient":{"address":{"address1":"100 Nowhere Blvd","address2":"Suite 100","city":"Gotham City","company_name":"Wayne Enterprises","country":"US","state":"NJ","zip_code":"07093"},"email":"john@example.com","name":"John Doe","phone_number":"555-555-5555"},"reference_id":"string","retailer_program_data":{"addresses":[{"address1":"100 Nowhere Blvd","address2":"Suite 100","city":"Gotham City","company_name":"Wayne Enterprises","country":"US","state":"NJ","type":"MarkFor","zip_code":"07093"}],"customer_ticket_number":"string","delivery_date":"2019-08-24T14:15:22Z","department":"string","doNotShipBeforeDate":"2019-08-24T14:15:22Z","mark_for_store":"string","purchase_order_number":"string","retailer_program_type":"string","shipByDate":"2019-08-24T14:15:22Z"},"shipments":[{"actual_fulfillment_date":"2019-08-24T14:15:22Z","created_date":"2019-08-24T14:15:22Z","delivery_date":"2019-08-24T14:15:22Z","estimated_fulfillment_date":"2019-08-24T14:15:22Z","estimated_fulfillment_date_status":"AwaitingInventoryAllocation","gift_message":"string","id":0,"insurance_value":0,"invoice_amount":0,"invoice_currency_code":"string","is_tracking_uploaded":true,"last_tracking_update_at":"2019-08-24T14:15:22Z","last_update_at":"2019-08-24T14:15:22Z","location":{"id":0,"name":"Cicero (IL)"},"measurements":{"depth_in":0,"length_in":0,"total_weight_oz":0,"width_in":0},"order_id":0,"package_material_type":"Unknown","parent_cartons":[{"barcode":"string","cartons":[{"barcode":"string","carton_details":[{"products":[{"id":0,"inventory_items":[{"expiration_date":"2019-08-24T14:15:22Z","id":0,"is_dangerous_goods":true,"lot":"22222","name":"Medium Blue T-Shirt","quantity":0,"quantity_committed":0,"serial_numbers":["string"]}],"name":"Medium Blue T-Shirt","reference_id":"TShirtBlueM","sku":"TShirtBlueM"}]}],"id":0,"measurements":{"depth_in":0.1,"length_in":0.1,"total_weight_oz":0.1,"width_in":0.1},"type":"Box or pallet"}],"measurements":{"depth_in":0.1,"length_in":0.1,"total_weight_oz":0.1,"width_in":0.1},"type":"Box or pallet"}],"products":[{"id":0,"inventory_items":[{"expiration_date":"2019-08-24T14:15:22Z","id":0,"is_dangerous_goods":true,"lot":"22222","name":"Medium Blue T-Shirt","quantity":0,"quantity_committed":0,"serial_numbers":["string"]}],"name":"Medium Blue T-Shirt","reference_id":"TShirtBlueM","sku":"TShirtBlueM"}],"recipient":{"address":{"address1":"100 Nowhere Blvd","address2":"Suite 100","city":"Gotham City","company_name":"Wayne Enterprises","country":"US","state":"NJ","zip_code":"07093"},"email":"john@example.com","full_name":"John Doe","name":"John Doe","phone_number":"555-555-5555"},"reference_id":"string","require_signature":true,"ship_option":"Standard","status":"None","status_details":[{"description":"string","exception_fulfillment_center_id":0,"extra_information":{"validation_messages":["string"]},"id":0,"inventory_id":0,"name":"string"}],"tracking":{"bol":"string","carrier":"USPS","carrier_service":"Priority","pro_number":"string","scac":"string","shipping_date":"2019-08-24T14:15:22Z","tracking_number":"860C8CDC8F0B4FC7AB69AC86C20539EC","tracking_url":"https://www.example.com/tracking?id=860C8CDC8F0B4FC7AB69AC86C20539EC"}}],"shipping_method":"Free 2-day Shipping","shipping_terms":{"carrier_type":"Parcel","payment_term":"Collect"},"status":"Processing","tags":[{"name":"Handling instructions","value":"Fragile"}],"type":"DTC"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.Post.Api.Order.Bad.Request.Object"},"example":{"property1":["string"],"property2":["string"]}}}},"401":{"description":"No access right at this time"},"403":{"description":"No access"},"422":{"description":"Client Error","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.Post.Api.Order.Unprocessable.Entity.Object"},"example":{"errors":["string"]}}}}},"requestBody":{"x-name":"orders.CreateOrderModel","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.CreateOrderModel"}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Orders"]}},"/2026-01/order/{orderId}:cancel":{"post":{"summary":"Cancel Order","description":"Cancels an order and all associated shipments. The order must be in a cancellable state to proceed with the cancellation.","parameters":[{"name":"orderId","in":"path","required":true,"description":"The order ID to cancel","schema":{"type":"string","format":"int32","additionalProperties":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.CanceledOrderViewModel"},"example":{"canceled_shipment_results":[{"action":"Cancel","is_success":true,"reason":"string","shipment_id":0}],"order":{"channel":{"id":0,"name":"ShipBobs-Shopify-Store"},"created_date":"2019-08-24T14:15:22Z","financials":{"total_price":0.1},"gift_message":"string","id":0,"order_number":"string","products":[{"external_line_id":0,"gtin":"string","id":0,"quantity":0,"quantity_unit_of_measure_code":"string","reference_id":"TShirtBlueM","sku":"TShirtBlueM","unit_price":0.1,"upc":"string"}],"purchase_date":"2019-08-24T14:15:22Z","recipient":{"address":{"address1":"100 Nowhere Blvd","address2":"Suite 100","city":"Gotham City","company_name":"Wayne Enterprises","country":"US","state":"NJ","zip_code":"07093"},"email":"john@example.com","name":"John Doe","phone_number":"555-555-5555"},"reference_id":"string","retailer_program_data":{"addresses":[{"address1":"100 Nowhere Blvd","address2":"Suite 100","city":"Gotham City","company_name":"Wayne Enterprises","country":"US","state":"NJ","type":"MarkFor","zip_code":"07093"}],"customer_ticket_number":"string","delivery_date":"2019-08-24T14:15:22Z","department":"string","doNotShipBeforeDate":"2019-08-24T14:15:22Z","mark_for_store":"string","purchase_order_number":"string","retailer_program_type":"string","shipByDate":"2019-08-24T14:15:22Z"},"shipments":[{"actual_fulfillment_date":"2019-08-24T14:15:22Z","created_date":"2019-08-24T14:15:22Z","delivery_date":"2019-08-24T14:15:22Z","estimated_fulfillment_date":"2019-08-24T14:15:22Z","estimated_fulfillment_date_status":"AwaitingInventoryAllocation","gift_message":"string","id":0,"insurance_value":0,"invoice_amount":0,"invoice_currency_code":"string","is_tracking_uploaded":true,"last_tracking_update_at":"2019-08-24T14:15:22Z","last_update_at":"2019-08-24T14:15:22Z","location":{"id":0,"name":"Cicero (IL)"},"measurements":{"depth_in":0,"length_in":0,"total_weight_oz":0,"width_in":0},"order_id":0,"package_material_type":"Unknown","parent_cartons":[{"barcode":"string","cartons":[{"barcode":"string","carton_details":[{"products":[{"id":0,"inventory_items":[{"expiration_date":"2019-08-24T14:15:22Z","id":0,"is_dangerous_goods":true,"lot":"22222","name":"Medium Blue T-Shirt","quantity":0,"quantity_committed":0,"serial_numbers":[null]}],"name":"Medium Blue T-Shirt","reference_id":"TShirtBlueM","sku":"TShirtBlueM"}]}],"id":0,"measurements":{"depth_in":0.1,"length_in":0.1,"total_weight_oz":0.1,"width_in":0.1},"type":"Box or pallet"}],"measurements":{"depth_in":0.1,"length_in":0.1,"total_weight_oz":0.1,"width_in":0.1},"type":"Box or pallet"}],"products":[{"id":0,"inventory_items":[{"expiration_date":"2019-08-24T14:15:22Z","id":0,"is_dangerous_goods":true,"lot":"22222","name":"Medium Blue T-Shirt","quantity":0,"quantity_committed":0,"serial_numbers":["string"]}],"name":"Medium Blue T-Shirt","reference_id":"TShirtBlueM","sku":"TShirtBlueM"}],"recipient":{"address":{"address1":"100 Nowhere Blvd","address2":"Suite 100","city":"Gotham City","company_name":"Wayne Enterprises","country":"US","state":"NJ","zip_code":"07093"},"email":"john@example.com","full_name":"John Doe","name":"John Doe","phone_number":"555-555-5555"},"reference_id":"string","require_signature":true,"ship_option":"Standard","status":"None","status_details":[{"description":"string","exception_fulfillment_center_id":0,"extra_information":{"validation_messages":["string"]},"id":0,"inventory_id":0,"name":"string"}],"tracking":{"bol":"string","carrier":"USPS","carrier_service":"Priority","pro_number":"string","scac":"string","shipping_date":"2019-08-24T14:15:22Z","tracking_number":"860C8CDC8F0B4FC7AB69AC86C20539EC","tracking_url":"https://www.example.com/tracking?id=860C8CDC8F0B4FC7AB69AC86C20539EC"}}],"shipping_method":"Free 2-day Shipping","shipping_terms":{"carrier_type":"Parcel","payment_term":"Collect"},"status":"Processing","tags":[{"name":"Handling instructions","value":"Fragile"}],"type":"DTC"},"order_id":0,"status":"Success"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.Post.Api.Order.OrderId.Cancel.Bad.Request.Object"},"example":{"property1":["string"],"property2":["string"]}}}},"401":{"description":"No access right at this time"},"403":{"description":"No access"},"404":{"description":"Not Found"},"422":{"description":"Client Error","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.Post.Api.Order.OrderId.Cancel.Unprocessable.Entity.Object"},"example":{"property1":["string"],"property2":["string"]}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.Post.Api.Order.OrderId.Cancel.Internal.Server.Error.Object"},"example":{"property1":["string"],"property2":["string"]}}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Orders"]}},"/2026-01/order:estimate":{"post":{"summary":"Estimate Fulfillment Cost For Order","description":"This endpoint will provide, where possible, an estimate of pricing and fulfillment center assignment of a potential standard (direct to consumer) order. Keep in mind that there are ways for the merchant to change FC assignment or product configuration after order creation that could invalidate this estimate. Estimates cannot be returned for items that are unknown, out of stock, or too large for fulfillment using standard box sizes. Additional services such as high-pick fees, shipping insurance, auto-splitting or auto-adding items to orders, and signature required are not included in this estimate.","parameters":[{"name":"shipbob_channel_id","in":"header","required":true,"description":"Channel Id for Operation","schema":{"type":"string","format":"int32","additionalProperties":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.EstimateViewModel"},"example":{"estimates":[{"estimated_currency_code":"string","estimated_price":0.1,"fulfillment_center":{"id":0,"name":"Cicero (IL)"},"shipping_method":"string","total_weight_oz":0.1}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.Post.Api.Order.Estimate.Bad.Request.Object"},"example":{"property1":["string"],"property2":["string"]}}}},"401":{"description":"No access right at this time"},"403":{"description":"No access"},"422":{"description":"Client Error","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.Post.Api.Order.Estimate.Unprocessable.Entity.Object"},"example":{"property1":["string"],"property2":["string"]}}}}},"requestBody":{"x-name":"orders.EstimateFulfillmentRequestModel","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.EstimateFulfillmentRequestModel"}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Orders"]}},"/2026-01/order/{orderId}/store-order-json":{"get":{"summary":"Get Order Store Data","description":"Retrieves the original store order data associated with the order in JSON format, preserving custom fields and metadata from the order source.","parameters":[{"name":"orderId","in":"path","required":true,"description":"The order ID to Get the JSON Stored","schema":{"type":"string","format":"int32","additionalProperties":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.Get.Api.Order.OrderId.StoreOrderJson.OK.String"},"example":"string"}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.Get.Api.Order.OrderId.StoreOrderJson.Bad.Request.Object"},"example":{"property1":["string"],"property2":["string"]}}}},"401":{"description":"No access right at this time"},"403":{"description":"No access"},"404":{"description":"Not Found"},"422":{"description":"Client Error","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.Get.Api.Order.OrderId.StoreOrderJson.Unprocessable.Entity.Object"},"example":{"property1":["string"],"property2":["string"]}}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Orders"]}},"/2026-01/shipment:batchUpdateTrackingUpload":{"post":{"summary":"Mark Tracking Uploaded","description":"Mark tracking information as synced to your external system for multiple shipments. Use this endpoint after syncing tracking data to update the IsTrackingUploaded flag, preventing these shipments from appearing in future GET /order queries with IsTrackingUploaded=false.\n\n<Tip>Use this endpoint if you're filtering orders by is_tracking_uploaded. This allows integrations to acknowledge that shipments have been successfully synced to their system.</Tip>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.BulkUpdateResponseModel"},"example":{"results":[{"error":{"code":"string","message":"string"},"isSuccess":true,"shipmentId":100810005}],"summary":{"failed":0,"successful":1,"total":1}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.Post.Api.Shipment.BulkUpdateTrackingUpload.Bad.Request.String"},"example":"string"}}},"401":{"description":"No access right at this time"},"403":{"description":"No access"},"404":{"description":"Not Found"}},"requestBody":{"x-name":"orders.BulkUpdateTrackingUploadModel","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.BulkUpdateTrackingUploadModel"}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Orders"]}},"/2026-01/shipment/{shipmentId}/logs":{"get":{"summary":"Get Shipment Logs","description":"Retrieves operational logs for a specific shipment by shipment ID, providing a detailed record of all events and status changes that have occurred.","parameters":[{"name":"shipmentId","in":"path","required":true,"description":"The shipment id to get","schema":{"type":"string","format":"int32","additionalProperties":false}},{"name":"shipbob_channel_id","in":"header","description":"Channel Id for Operation","schema":{"type":"string","format":"int32","additionalProperties":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.ShipmentLogViewModelArray"},"example":[{"log_type_id":0,"log_type_name":"string","log_type_text":"string","metadata":{"property1":"string","property2":"string"},"timestamp":"2019-08-24T14:15:22Z"}]}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.Get.Api.Shipment.ShipmentId.Logs.Bad.Request.Object"},"example":{"property1":["string"],"property2":["string"]}}}},"401":{"description":"No access right at this time"},"403":{"description":"No access"},"404":{"description":"Not Found"}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Orders"]}},"/2026-01/order/{orderId}/shipment/{shipmentId}":{"get":{"summary":"Get Shipment by Order ID and Shipment ID","description":"Retrieves detailed shipment information for a specific order and shipment combination, including shipment status, tracking information, fulfillment center location, and contained products.","parameters":[{"name":"orderId","in":"path","required":true,"description":"The order id to get the shipment for","schema":{"type":"string","format":"int32","additionalProperties":false}},{"name":"shipmentId","in":"path","required":true,"description":"The shipment id to get","schema":{"type":"string","format":"int32","additionalProperties":false}},{"name":"shipbob_channel_id","in":"header","description":"Channel Id for Operation","schema":{"type":"string","format":"int32","additionalProperties":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.ShipmentViewModel"},"example":{"actual_fulfillment_date":"2019-08-24T14:15:22Z","created_date":"2019-08-24T14:15:22Z","delivery_date":"2019-08-24T14:15:22Z","estimated_fulfillment_date":"2019-08-24T14:15:22Z","estimated_fulfillment_date_status":"AwaitingInventoryAllocation","gift_message":"string","id":0,"insurance_value":0,"invoice_amount":0,"invoice_currency_code":"string","is_tracking_uploaded":true,"last_tracking_update_at":"2019-08-24T14:15:22Z","last_update_at":"2019-08-24T14:15:22Z","location":{"id":0,"name":"Cicero (IL)"},"measurements":{"depth_in":0,"length_in":0,"total_weight_oz":0,"width_in":0},"order_id":0,"package_material_type":"Unknown","parent_cartons":[{"barcode":"string","cartons":[{"barcode":"string","carton_details":[{"products":[{"id":0,"inventory_items":[{"expiration_date":"2019-08-24T14:15:22Z","id":0,"is_dangerous_goods":true,"lot":"22222","name":"Medium Blue T-Shirt","quantity":0,"quantity_committed":0,"serial_numbers":["string"]}],"name":"Medium Blue T-Shirt","reference_id":"TShirtBlueM","sku":"TShirtBlueM"}]}],"id":0,"measurements":{"depth_in":0.1,"length_in":0.1,"total_weight_oz":0.1,"width_in":0.1},"type":"Box or pallet"}],"measurements":{"depth_in":0.1,"length_in":0.1,"total_weight_oz":0.1,"width_in":0.1},"type":"Box or pallet"}],"products":[{"id":0,"inventory_items":[{"expiration_date":"2019-08-24T14:15:22Z","id":0,"is_dangerous_goods":true,"lot":"22222","name":"Medium Blue T-Shirt","quantity":0,"quantity_committed":0,"serial_numbers":["string"]}],"name":"Medium Blue T-Shirt","reference_id":"TShirtBlueM","sku":"TShirtBlueM"}],"recipient":{"address":{"address1":"100 Nowhere Blvd","address2":"Suite 100","city":"Gotham City","company_name":"Wayne Enterprises","country":"US","state":"NJ","zip_code":"07093"},"email":"john@example.com","full_name":"John Doe","name":"John Doe","phone_number":"555-555-5555"},"reference_id":"string","require_signature":true,"ship_option":"Standard","status":"None","status_details":[{"description":"string","exception_fulfillment_center_id":0,"extra_information":{"validation_messages":["string"]},"id":0,"inventory_id":0,"name":"string"}],"tracking":{"bol":"string","carrier":"USPS","carrier_service":"Priority","pro_number":"string","scac":"string","shipping_date":"2019-08-24T14:15:22Z","tracking_number":"860C8CDC8F0B4FC7AB69AC86C20539EC","tracking_url":"https://www.example.com/tracking?id=860C8CDC8F0B4FC7AB69AC86C20539EC"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.Bad.Request.Object"},"example":{"property1":["string"],"property2":["string"]}}}},"401":{"description":"No access right at this time"},"403":{"description":"No access"},"404":{"description":"Not Found"}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Orders"]}},"/2026-01/order/{orderId}":{"get":{"summary":"Get Order","description":"Retrieves detailed information about a specific order by its order ID, including order status, shipments, products, and recipient details.","parameters":[{"name":"orderId","in":"path","required":true,"description":"","schema":{"type":"string","format":"int32","additionalProperties":false}},{"name":"shipbob_channel_id","in":"header","description":"Channel Id for Operation","schema":{"type":"string","format":"int32","additionalProperties":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.OrderViewModel"},"example":{"channel":{"id":0,"name":"ShipBobs-Shopify-Store"},"created_date":"2019-08-24T14:15:22Z","financials":{"total_price":0.1},"gift_message":"string","id":0,"order_number":"string","products":[{"external_line_id":0,"gtin":"string","id":0,"quantity":0,"quantity_unit_of_measure_code":"string","reference_id":"TShirtBlueM","sku":"TShirtBlueM","unit_price":0.1,"upc":"string"}],"purchase_date":"2019-08-24T14:15:22Z","recipient":{"address":{"address1":"100 Nowhere Blvd","address2":"Suite 100","city":"Gotham City","company_name":"Wayne Enterprises","country":"US","state":"NJ","zip_code":"07093"},"email":"john@example.com","name":"John Doe","phone_number":"555-555-5555"},"reference_id":"string","retailer_program_data":{"addresses":[{"address1":"100 Nowhere Blvd","address2":"Suite 100","city":"Gotham City","company_name":"Wayne Enterprises","country":"US","state":"NJ","type":"MarkFor","zip_code":"07093"}],"customer_ticket_number":"string","delivery_date":"2019-08-24T14:15:22Z","department":"string","doNotShipBeforeDate":"2019-08-24T14:15:22Z","mark_for_store":"string","purchase_order_number":"string","retailer_program_type":"string","shipByDate":"2019-08-24T14:15:22Z"},"shipments":[{"actual_fulfillment_date":"2019-08-24T14:15:22Z","created_date":"2019-08-24T14:15:22Z","delivery_date":"2019-08-24T14:15:22Z","estimated_fulfillment_date":"2019-08-24T14:15:22Z","estimated_fulfillment_date_status":"AwaitingInventoryAllocation","gift_message":"string","id":0,"insurance_value":0,"invoice_amount":0,"invoice_currency_code":"string","is_tracking_uploaded":true,"last_tracking_update_at":"2019-08-24T14:15:22Z","last_update_at":"2019-08-24T14:15:22Z","location":{"id":0,"name":"Cicero (IL)"},"measurements":{"depth_in":0,"length_in":0,"total_weight_oz":0,"width_in":0},"order_id":0,"package_material_type":"Unknown","parent_cartons":[{"barcode":"string","cartons":[{"barcode":"string","carton_details":[{"products":[{"id":0,"inventory_items":[{"expiration_date":"2019-08-24T14:15:22Z","id":0,"is_dangerous_goods":true,"lot":"22222","name":"Medium Blue T-Shirt","quantity":0,"quantity_committed":0,"serial_numbers":["string"]}],"name":"Medium Blue T-Shirt","reference_id":"TShirtBlueM","sku":"TShirtBlueM"}]}],"id":0,"measurements":{"depth_in":0.1,"length_in":0.1,"total_weight_oz":0.1,"width_in":0.1},"type":"Box or pallet"}],"measurements":{"depth_in":0.1,"length_in":0.1,"total_weight_oz":0.1,"width_in":0.1},"type":"Box or pallet"}],"products":[{"id":0,"inventory_items":[{"expiration_date":"2019-08-24T14:15:22Z","id":0,"is_dangerous_goods":true,"lot":"22222","name":"Medium Blue T-Shirt","quantity":0,"quantity_committed":0,"serial_numbers":["string"]}],"name":"Medium Blue T-Shirt","reference_id":"TShirtBlueM","sku":"TShirtBlueM"}],"recipient":{"address":{"address1":"100 Nowhere Blvd","address2":"Suite 100","city":"Gotham City","company_name":"Wayne Enterprises","country":"US","state":"NJ","zip_code":"07093"},"email":"john@example.com","full_name":"John Doe","name":"John Doe","phone_number":"555-555-5555"},"reference_id":"string","require_signature":true,"ship_option":"Standard","status":"None","status_details":[{"description":"string","exception_fulfillment_center_id":0,"extra_information":{"validation_messages":["string"]},"id":0,"inventory_id":0,"name":"string"}],"tracking":{"bol":"string","carrier":"USPS","carrier_service":"Priority","pro_number":"string","scac":"string","shipping_date":"2019-08-24T14:15:22Z","tracking_number":"860C8CDC8F0B4FC7AB69AC86C20539EC","tracking_url":"https://www.example.com/tracking?id=860C8CDC8F0B4FC7AB69AC86C20539EC"}}],"shipping_method":"Free 2-day Shipping","shipping_terms":{"carrier_type":"Parcel","payment_term":"Collect"},"status":"Processing","tags":[{"name":"Handling instructions","value":"Fragile"}],"type":"DTC"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.Get.Api.Order.OrderId.Bad.Request.Object"},"example":{"property1":["string"],"property2":["string"]}}}},"401":{"description":"No access right at this time"},"403":{"description":"No access"},"404":{"description":"Not Found"}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Orders"]}},"/2026-01/order/{orderId}/shipment/{shipmentId}:cancel":{"post":{"summary":"Cancel Shipment by Order ID and Shipment ID","description":"Cancels a specific shipment by order ID and shipment ID. The shipment must not be picked, packed, or shipped to proceed with the cancellation.","parameters":[{"name":"shipmentId","in":"path","required":true,"description":"The shipment id to get","schema":{"type":"string","format":"int32","additionalProperties":false}},{"name":"orderId","in":"path","required":true,"description":"","schema":{"type":"string","additionalProperties":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.ShipmentViewModel"},"example":{"actual_fulfillment_date":"2019-08-24T14:15:22Z","created_date":"2019-08-24T14:15:22Z","delivery_date":"2019-08-24T14:15:22Z","estimated_fulfillment_date":"2019-08-24T14:15:22Z","estimated_fulfillment_date_status":"AwaitingInventoryAllocation","gift_message":"string","id":0,"insurance_value":0,"invoice_amount":0,"invoice_currency_code":"string","is_tracking_uploaded":true,"last_tracking_update_at":"2019-08-24T14:15:22Z","last_update_at":"2019-08-24T14:15:22Z","location":{"id":0,"name":"Cicero (IL)"},"measurements":{"depth_in":0,"length_in":0,"total_weight_oz":0,"width_in":0},"order_id":0,"package_material_type":"Unknown","parent_cartons":[{"barcode":"string","cartons":[{"barcode":"string","carton_details":[{"products":[{"id":0,"inventory_items":[{"expiration_date":"2019-08-24T14:15:22Z","id":0,"is_dangerous_goods":true,"lot":"22222","name":"Medium Blue T-Shirt","quantity":0,"quantity_committed":0,"serial_numbers":["string"]}],"name":"Medium Blue T-Shirt","reference_id":"TShirtBlueM","sku":"TShirtBlueM"}]}],"id":0,"measurements":{"depth_in":0.1,"length_in":0.1,"total_weight_oz":0.1,"width_in":0.1},"type":"Box or pallet"}],"measurements":{"depth_in":0.1,"length_in":0.1,"total_weight_oz":0.1,"width_in":0.1},"type":"Box or pallet"}],"products":[{"id":0,"inventory_items":[{"expiration_date":"2019-08-24T14:15:22Z","id":0,"is_dangerous_goods":true,"lot":"22222","name":"Medium Blue T-Shirt","quantity":0,"quantity_committed":0,"serial_numbers":["string"]}],"name":"Medium Blue T-Shirt","reference_id":"TShirtBlueM","sku":"TShirtBlueM"}],"recipient":{"address":{"address1":"100 Nowhere Blvd","address2":"Suite 100","city":"Gotham City","company_name":"Wayne Enterprises","country":"US","state":"NJ","zip_code":"07093"},"email":"john@example.com","full_name":"John Doe","name":"John Doe","phone_number":"555-555-5555"},"reference_id":"string","require_signature":true,"ship_option":"Standard","status":"None","status_details":[{"description":"string","exception_fulfillment_center_id":0,"extra_information":{"validation_messages":["string"]},"id":0,"inventory_id":0,"name":"string"}],"tracking":{"bol":"string","carrier":"USPS","carrier_service":"Priority","pro_number":"string","scac":"string","shipping_date":"2019-08-24T14:15:22Z","tracking_number":"860C8CDC8F0B4FC7AB69AC86C20539EC","tracking_url":"https://www.example.com/tracking?id=860C8CDC8F0B4FC7AB69AC86C20539EC"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.Post.Api.Order.OrderId.Shipment.ShipmentId.Cancel.Bad.Request.Object"},"example":{"property1":["string"],"property2":["string"]}}}},"401":{"description":"No access right at this time"},"403":{"description":"No access"},"404":{"description":"Not Found"},"422":{"description":"Client Error","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.Post.Api.Order.OrderId.Shipment.ShipmentId.Cancel.Unprocessable.Entity.Object"},"example":{"property1":["string"],"property2":["string"]}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.Post.Api.Order.OrderId.Shipment.ShipmentId.Cancel.Internal.Server.Error.Object"},"example":{"property1":["string"],"property2":["string"]}}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Orders"]}},"/2026-01/shipment/{shipmentId}/timeline":{"get":{"summary":"Get Shipment Timeline","description":"Retrieves a chronological timeline of shipment status updates by shipment ID, showing when each status change occurred and providing visibility into the fulfillment progress.","parameters":[{"name":"shipmentId","in":"path","required":true,"description":"The shipment id to get","schema":{"type":"string","format":"int32","additionalProperties":false}},{"name":"shipbob_channel_id","in":"header","description":"Channel Id for Operation","schema":{"type":"string","format":"int32","additionalProperties":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.ShipmentLogViewModelArray"},"example":[{"log_type_id":0,"log_type_name":"string","log_type_text":"string","metadata":{"property1":"string","property2":"string"},"timestamp":"2019-08-24T14:15:22Z"}]}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.Get.Api.Shipment.ShipmentId.Timeline.Bad.Request.Object"},"example":{"property1":["string"],"property2":["string"]}}}},"401":{"description":"No access right at this time"},"403":{"description":"No access"},"404":{"description":"Not Found"}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Orders"]}},"/2026-01/order/{orderId}/shipment/{shipmentId}/logs":{"get":{"summary":"Get Shipment Logs by Order ID and Shipment ID","description":"Retrieves operational logs for a specific shipment by shipment ID, providing a detailed record of all events and status changes that have occurred.","parameters":[{"name":"orderId","in":"path","required":true,"description":"The order id to get the shipment for","schema":{"type":"string","format":"int32","additionalProperties":false}},{"name":"shipmentId","in":"path","required":true,"description":"The shipment id to get","schema":{"type":"string","format":"int32","additionalProperties":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.ShipmentLogViewModelArray"},"example":[{"log_type_id":0,"log_type_name":"string","log_type_text":"string","metadata":{"property1":"string","property2":"string"},"timestamp":"2019-08-24T14:15:22Z"}]}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.Logs.Bad.Request.Object"},"example":{"property1":["string"],"property2":["string"]}}}},"401":{"description":"No access right at this time"},"403":{"description":"No access"},"404":{"description":"Not Found"}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Orders"]}},"/2026-01/receiving:setExternalSync":{"post":{"summary":"Set ExternalSync flag for Wros\n","description":"Sets the external sync flag for one or more warehouse receiving orders to enable or disable external synchronization.\n","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Receiving.V2.WarehouseReceivingOrderViewModel"},"example":{"box_labels_uri":"https://api.shipbob.com/2026-01/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"]}},"/2026-01/fulfillment-center":{"get":{"summary":"Get Fulfillment Centers\n","description":"Returns a list of ShipBob fulfillment centers where inventory can be received.\n","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Receiving.FulfillmentCenterViewModelArray"},"example":[{"address1":"5900 W Ogden Ave","address2":"Suite 100","city":"Cicero","country":"USA","email":"example@example.com","id":0,"name":"Cicero (IL)","phone_number":"555-555-5555","state":"IL","timezone":"Central Standard Time","zip_code":"60804"}]}}},"401":{"description":"Authorization missing or invalid"},"403":{"description":"The provided credentials are not authorized to access this resource"}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Receiving"]}},"/2026-01/receiving/{id}:cancel":{"post":{"summary":"Cancel Warehouse Receiving Order\n","description":"Cancels an existing warehouse receiving order. Only orders in certain statuses can be cancelled.\n","parameters":[{"name":"id","in":"path","required":true,"description":"Id of the receiving order to cancel","schema":{"type":"string","format":"int32","additionalProperties":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Receiving.V2.WarehouseReceivingOrderViewModel"},"example":{"box_labels_uri":"https://api.shipbob.com/2026-01/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","status_history":[{"id":0,"status":"Processing","timestamp":"2019-08-24T14:15:22Z"}]}}}},"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/Receiving.ValidationProblemDetails"},"example":{"detail":"string","errors":{"property1":["string"],"property2":["string"]},"instance":"string","property1":{},"property2":{},"status":0,"title":"string","type":"string"}}}},"422":{"description":"Client Error","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Receiving.Post.2.0.Receiving.Id.Cancel.Unprocessable.Entity.Object"},"example":{"property1":["string"],"property2":["string"]}}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Receiving"]}},"/2026-01/receiving":{"get":{"summary":"Get Multiple Warehouse Receiving Orders\n","description":"Returns a list of warehouse receiving orders with optional filtering by status, fulfillment center, purchase order number, and date range.\n","parameters":[{"name":"Page","in":"query","description":"Page of WROs to get\n","schema":{"type":"string","format":"int32","additionalProperties":false}},{"name":"Limit","in":"query","description":"Number of WROs per page to request\n","schema":{"type":"string","format":"int32","additionalProperties":false}},{"name":"IDs","in":"query","description":"Comma separated list of WRO IDs to filter by\n","schema":{"type":"string","additionalProperties":false,"items":{"type":"integer","format":"int32","additionalProperties":false}}},{"name":"Statuses","in":"query","description":"Comma separated list of WRO statuses to filter by\n","schema":{"type":"string","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Receiving.ReceivingStatus"}}},{"name":"InsertStartDate","in":"query","description":"Earliest date that a WRO was created\n","schema":{"type":"string","format":"date-time","additionalProperties":false}},{"name":"InsertEndDate","in":"query","description":"Latest date that a WRO was created\n","schema":{"type":"string","format":"date-time","additionalProperties":false}},{"name":"FulfillmentCenterIds","in":"query","description":"Comma separated list of WRO fulfillment center IDs to filter by\n","schema":{"type":"string","additionalProperties":false,"items":{"type":"integer","format":"int32","additionalProperties":false}}},{"name":"PurchaseOrderNumbers","in":"query","description":"Comma separated list of WRO PO numbers to filter by\n","schema":{"type":"string","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},{"name":"ExternalSync","in":"query","description":"Flag to return external_sync_timestamp WROs\n","schema":{"type":"boolean","additionalProperties":false}},{"name":"CompletedStartDate","in":"query","description":"Earliest date that a WRO was completed\n","schema":{"type":"string","format":"date-time","additionalProperties":false}},{"name":"CompletedEndDate","in":"query","description":"Latest date that a WRO was completed\n","schema":{"type":"string","format":"date-time","additionalProperties":false}}],"responses":{"200":{"description":"Success","headers":{"Page-Number":{"description":"Number of the current page\n","schema":{"type":"object","additionalProperties":false}},"Total-Pages":{"description":"Total number of pages of results\n","schema":{"type":"object","additionalProperties":false}},"Total-Count":{"description":"Total number of results\n","schema":{"type":"object","additionalProperties":false}},"Page-Size":{"description":"Number of results per page\n","schema":{"type":"object","additionalProperties":false}},"Next-Page":{"description":"The href of the next page of results, if there is a next page\n","schema":{"type":"object","additionalProperties":false}}},"content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Receiving.V2.WarehouseReceivingOrderViewModelArray"},"example":[{"box_labels_uri":"https://api.shipbob.com/2026-01/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","status_history":[{"id":0,"status":"Processing","timestamp":"2019-08-24T14:15:22Z"}]}]}}},"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/Receiving.ValidationProblemDetails"},"example":{"detail":"string","errors":{"property1":["string"],"property2":["string"]},"instance":"string","property1":{},"property2":{},"status":0,"title":"string","type":"string"}}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Receiving"]},"post":{"summary":"Create Warehouse Receiving Order\n","description":"Creates a new warehouse receiving order with specified fulfillment center, boxes, and inventory items.\n","responses":{"201":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Receiving.V2.WarehouseReceivingOrderViewModel"},"example":{"box_labels_uri":"https://api.shipbob.com/2026-01/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","status_history":[{"id":0,"status":"Processing","timestamp":"2019-08-24T14:15:22Z"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Receiving.Post.2.0.Receiving.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"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Receiving.ValidationProblemDetails"},"example":{"detail":"string","errors":{"property1":["string"],"property2":["string"]},"instance":"string","property1":{},"property2":{},"status":0,"title":"string","type":"string"}}}}},"requestBody":{"x-name":"receiving.CreateReceivingOrderModel","description":"The receiving order to create","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Receiving.CreateReceivingOrderModel"}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Receiving"]}},"/2026-01/receiving/{id}/boxes":{"get":{"summary":"Get Warehouse Receiving Order Boxes\n","description":"Returns the boxes and their contents for a specific warehouse receiving order.\n","parameters":[{"name":"id","in":"path","required":true,"description":"Id of the receiving order","schema":{"type":"string","format":"int32","additionalProperties":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Receiving.BoxViewModelArray"},"example":[{"arrived_date":"2019-08-24T14:15:22Z","box_id":0,"box_items":[{"inventory_id":0,"lot_date":"2019-08-24T14:15:22Z","lot_number":"string","quantity":0,"received_quantity":0,"stowed_quantity":0}],"box_number":0,"box_status":"Awaiting","counting_started_date":"2019-08-24T14:15:22Z","received_date":"2019-08-24T14:15:22Z","tracking_number":"860C8CDC8F0B4FC7AB69AC86C20539EC"}]}}},"401":{"description":"Authorization missing or invalid"},"403":{"description":"The provided credentials are not authorized to access this resource"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Receiving.ValidationProblemDetails"},"example":{"detail":"string","errors":{"property1":["string"],"property2":["string"]},"instance":"string","property1":{},"property2":{},"status":0,"title":"string","type":"string"}}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Receiving"]}},"/2026-01/receiving/{id}/labels":{"get":{"summary":"Get Warehouse Receiving Order Box Labels\n","description":"Returns a PDF containing box labels for a specific warehouse receiving order.\n","parameters":[{"name":"id","in":"path","required":true,"description":"Id of the receiving order","schema":{"type":"string","format":"int32","additionalProperties":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Receiving.Get.2.0.Receiving.Id.Labels.OK.String"},"example":"string"}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Receiving.ValidationProblemDetails"},"example":{"detail":"string","errors":{"property1":["string"],"property2":["string"]},"instance":"string","property1":{},"property2":{},"status":0,"title":"string","type":"string"}}}},"401":{"description":"Authorization missing or invalid"},"403":{"description":"The provided credentials are not authorized to access this resource"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Receiving.ValidationProblemDetails"},"example":{"detail":"string","errors":{"property1":["string"],"property2":["string"]},"instance":"string","property1":{},"property2":{},"status":0,"title":"string","type":"string"}}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Receiving"]}},"/2026-01/receiving/{id}":{"get":{"summary":"Get Warehouse Receiving Order\n","description":"Returns details of a specific warehouse receiving order by ID.\n","parameters":[{"name":"id","in":"path","required":true,"description":"Id of the receiving order\n","schema":{"type":"string","format":"int32","additionalProperties":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Receiving.V2.WarehouseReceivingOrderViewModel"},"example":{"box_labels_uri":"https://api.shipbob.com/2026-01/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","status_history":[{"id":0,"status":"Processing","timestamp":"2019-08-24T14:15:22Z"}]}}}},"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/Receiving.ValidationProblemDetails"},"example":{"detail":"string","errors":{"property1":["string"],"property2":["string"]},"instance":"string","property1":{},"property2":{},"status":0,"title":"string","type":"string"}}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Receiving"]}},"/2026-01/inventory/history:query":{"post":{"summary":"Query Inventory History Events","description":"Fetches inventory movement events that change on-hand quantities within the ShipBob network. Returns events such as receiving/stow, order picks, adjustments, restocks, and attribute updates. Filter by inventory IDs, event category, date range, and facility. Supports cursor-based pagination for large result sets.","parameters":[{"name":"cursor","in":"query","description":"","schema":{"type":"string","format":"int32","additionalProperties":false}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/FulfillmentCenterInventoryService.InventoryHistoryResponse"},"example":{"data":[{"additional_reference":[{"key":"string","value":"string"}],"decrement":{"committed_quantity_change":0,"expiration_date":"2019-08-24T14:15:22Z","facility_id":0,"inventory_status":"string","location_id":0,"lot_number":"string","operational_stage":{"description":"string","id":0},"pack_description_id":{"random":"string","time":"2019-08-24T14:15:22Z"},"quantity_change":0,"sku":"string","yuki_id":{"random":"string","time":"2019-08-24T14:15:22Z"}},"event_category":"string","event_datetime":"2019-08-24T14:15:22Z","increment":{"committed_quantity_change":0,"expiration_date":"2019-08-24T14:15:22Z","facility_id":0,"inventory_status":"string","location_id":0,"lot_number":"string","operational_stage":{"description":"string","id":0},"pack_description_id":{"random":"string","time":"2019-08-24T14:15:22Z"},"quantity_change":0,"sku":"string","yuki_id":{"random":"string","time":"2019-08-24T14:15:22Z"}},"inventory_audit_event_id":0,"inventory_id":0,"merchant_user_id":0,"shipbob_order_id":0}],"first":"string","last":"string","next":"string","prev":"string"}}}}},"requestBody":{"x-name":"fulfillmentCenterInventoryService.MerchantHistoryRequest","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/FulfillmentCenterInventoryService.MerchantHistoryRequest"}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Inventory History"]}},"/2026-01/receiving/{id}/distributions":{"get":{"summary":"Get Inventory Distributions by WRO ID","description":"Retrieves the distribution details for a specific receiving order within ShipBob's Inventory Placement Program (IPP).\n<Warning>This endpoint is available only to accounts enrolled in ShipBob's Inventory Placement Program (IPP).</Warning>","parameters":[{"name":"id","in":"path","required":true,"description":"Id of the receiving order\n","schema":{"type":"string","format":"int32","additionalProperties":false}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Receiving.WroDistributionDetailsResponse"},"example":{"distributions":[{"expected_quantity":0,"fulfillment_center_abbreviation":"string","fulfillment_center_id":0,"inventory_id":0,"lot_date":"2019-08-24T14:15:22Z","lot_number":"string","product_sku":"string","received_quantity":0,"status":"NotStarted","stowed_quantity":0}],"id":0,"status":"Awaiting"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Receiving.ProblemDetails"},"example":{"property1":null,"property2":null}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Receiving.ProblemDetails"},"example":{"property1":null,"property2":null}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"additionalProperties":false,"$ref":"#/components/schemas/Receiving.ProblemDetails"},"example":{"property1":null,"property2":null}}}}},"security":[{"PAT":[]},{"OAuth2":[]}],"tags":["Receiving"]}}},"components":{"schemas":{"Billing.Get.Api.V3.Invoices.Cursor.String":{"type":"string","description":"Cursor for pagination. Used to retrieve the next set of invoice results.","additionalProperties":false},"Billing.Get.Api.V3.Invoices.FromDate.String":{"type":"string","description":"Start date for filtering invoices. Must be in ISO 8601 date-time format.","format":"date-time","additionalProperties":false},"Billing.Get.Api.V3.Invoices.InvoiceId.Transactions.Cursor.String":{"type":"string","description":"Cursor for pagination. Used to retrieve the next set of transaction results.","additionalProperties":false},"Billing.Get.Api.V3.Invoices.InvoiceId.Transactions.InvoiceId.Integer":{"type":"integer","description":"The unique identifier of the invoice whose transactions are to be retrieved.","format":"int32","example":12345,"additionalProperties":false},"Billing.Get.Api.V3.Invoices.InvoiceId.Transactions.PageSize.Integer":{"type":"integer","description":"Number of transactions to return per page. Default is 100. Must be between 1 and 1000.","format":"int32","default":100,"additionalProperties":false},"Billing.Get.Api.V3.Invoices.InvoiceTypes.StringArray":{"type":"array","description":"Array of invoice types for filtering.","example":["Shipping","WarehouseStorage"],"additionalProperties":false,"items":{"type":"string","additionalProperties":false,"enum":["Shipping","WarehouseStorage","Inbound Fee","Return","AdditionalFee","Credits"]}},"Billing.Get.Api.V3.Invoices.PageSize.Integer":{"type":"integer","description":"Number of invoices to return per page. Default is 100. Must be between 1 and 1000.","format":"int32","default":100,"additionalProperties":false},"Billing.Get.Api.V3.Invoices.ToDate.String":{"type":"string","description":"End date for filtering invoices. Must be in ISO 8601 date-time format.","format":"date-time","additionalProperties":false},"Billing.InvoiceDtoCursorPagedResponseV3":{"type":"object","description":"Paginated response containing a list of invoices with navigation links for cursor-based pagination.","additionalProperties":false,"properties":{"first":{"type":"string","description":"Go to the first page","additionalProperties":false,"nullable":true},"items":{"type":"array","description":"List of invoices in the current page.","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Billing.InvoiceDtoV3"},"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.InvoiceDtoV3":{"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},"currency_code":{"type":"string","description":"The ISO currency code used in the invoice (e.g., USD, EUR).","example":"USD","additionalProperties":false,"nullable":true},"invoice_date":{"type":"string","description":"The invoice date in yyyy-mm-dd format.","additionalProperties":false,"nullable":true},"invoice_id":{"type":"integer","description":"Unique identifier for the invoice.","format":"int32","example":12345,"additionalProperties":false},"invoice_type":{"type":"string","description":"The type or category of the invoice.","additionalProperties":false,"enum":["Shipping","Inbound Fee","WarehouseStorage","AdditionalFee","Return","Credits","BalanceAdjustment","Payment"],"nullable":true},"running_balance":{"type":"number","description":"The running balance of the account after this invoice is applied.","format":"double","example":123.01,"additionalProperties":false}}},"Billing.InvoiceTaxDtoV3":{"type":"object","description":"Tax information associated with a transaction or invoice.","additionalProperties":false,"properties":{"tax_amount":{"type":"number","description":"Tax amount charged for this tax type.","format":"double","example":0.01,"additionalProperties":false},"tax_rate":{"type":"number","description":"Tax rate applied as a percentage.","format":"double","example":10,"additionalProperties":false},"tax_type":{"type":"string","description":"Type of tax applied.","example":"GST","additionalProperties":false,"nullable":true}}},"Billing.Post.Api.V3.Transactions.Query.Cursor.String":{"type":"string","description":"Cursor for pagination. Used to retrieve the next set of transaction query results.","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","description":"Sort order for results. Ascending sorts from lowest to highest, Descending sorts from highest to lowest.","default":"Descending","additionalProperties":false,"enum":["Ascending","Descending"]},"Billing.TransactionDtoCursorPagedResponseV3":{"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.TransactionDtoV3"},"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.TransactionDtoV3":{"type":"object","description":"Represents a transaction data object.","additionalProperties":false,"properties":{"additional_details":{"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":"The charge amount for the transaction.","format":"double","example":0.09,"additionalProperties":false,"nullable":true},"charge_date":{"type":"string","description":"The date when the transaction was charged.","example":"2025-01-01","additionalProperties":false,"nullable":true},"currency_code":{"type":"string","description":"The ISO currency code (e.g., USD, EUR) for the transaction.","example":"USD","additionalProperties":false,"nullable":true},"fulfillment_center":{"type":"string","description":"The name or code of the fulfillment center involved in the transaction.","example":"Altona VIC","additionalProperties":false,"nullable":true},"invoice_date":{"type":"string","description":"The date the invoice was generated.","example":"2025-01-01","additionalProperties":false,"nullable":true},"invoice_id":{"type":"integer","description":"The unique identifier of the invoice associated with this transaction.","format":"int32","example":12345,"additionalProperties":false,"nullable":true},"invoice_type":{"type":"string","description":"The type or category of the invoice.","example":"Shipping","additionalProperties":false,"enum":["Shipping","Inbound Fee","WarehouseStorage","AdditionalFee","Return","Credits","BalanceAdjustment","Payment"],"nullable":true},"invoiced_status":{"type":"boolean","description":"Indicates whether the transaction has been invoiced. True if billed, false if unbilled.","additionalProperties":false,"nullable":true},"reference_id":{"type":"string","description":"A unique reference identifier associated with the transaction.","example":"12345","additionalProperties":false,"nullable":true},"reference_type":{"type":"string","description":"The type of reference associated with the reference ID.","example":"Shipment","additionalProperties":false,"enum":["Shipment","Return","WRO","URO","Ticket Number","FC","LPN Reference","Transfer Plan"],"nullable":true},"taxes":{"type":"array","description":"A list of tax details applied to the transaction, if any exist.","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Billing.InvoiceTaxDtoV3"},"nullable":true},"transaction_fee":{"type":"string","description":"The fee type associated with the transaction. To get all available transaction fees, use the '/transaction-fees' endpoint.","example":"Shipping","additionalProperties":false,"nullable":true},"transaction_id":{"type":"string","description":"The unique identifier for the transaction.","example":"01AN4Z07BY79KA1307SR9X4MV3","additionalProperties":false,"nullable":true},"transaction_type":{"type":"string","description":"The classification or nature of the transaction.","example":"Charge","additionalProperties":false,"enum":["Charge","Refund","Credit","Payment","BalanceAdjustment"],"nullable":true}}},"Billing.TransactionFeeModelV3":{"type":"object","description":"Response model containing available transaction fee types.","additionalProperties":false,"properties":{"fee_list":{"type":"array","description":"Available transaction fee types for billing operations.","example":["Shipping","Warehousing Fee","Return Fee"],"additionalProperties":false,"items":{"type":"string","additionalProperties":false},"nullable":true}}},"Billing.TransactionRequestFilterV3":{"type":"object","example":{"from_date":"2019-08-24","invoice_ids":["12345"],"invoiced_status":true,"page_size":10,"reference_ids":["11553288","43-12000928-Pallet00"],"reference_types":["FC"],"sort_order":"Ascending","to_date":"2019-08-24","transaction_fees":["Kitting Fee","Warehousing Fee"],"transaction_types":["Charge"]},"additionalProperties":false,"properties":{"from_date":{"type":"string","description":"Start date for filtering transactions by charge date. Defaults to 7 days before the current date if not specified.","format":"date-time","additionalProperties":false,"nullable":true},"invoice_ids":{"type":"array","description":"List of invoice IDs to filter transactions by.","additionalProperties":false,"items":{"type":"string","additionalProperties":false},"nullable":true},"invoiced_status":{"type":"boolean","description":"Filter transactions by invoicing status. True returns billed transactions, false returns unbilled transactions, and null returns both billed and unbilled transactions.","additionalProperties":false,"nullable":true},"page_size":{"type":"integer","description":"Number of transactions to return per page. Default is 100. Must be between 1 and 1000.","format":"int32","additionalProperties":false},"reference_ids":{"type":"array","description":"List of reference IDs (such as Shipment IDs, WRO IDs) to filter transactions. Can be numeric or string identifiers.","additionalProperties":false,"items":{"type":"string","additionalProperties":false},"nullable":true},"reference_types":{"type":"array","description":"The types of references associated with the reference IDs to filter by.","additionalProperties":false,"items":{"type":"string","additionalProperties":false,"enum":["Shipment","Return","WRO","URO"]},"nullable":true},"sort_order":{"additionalProperties":false,"$ref":"#/components/schemas/Billing.SortOrder"},"to_date":{"type":"string","description":"End date for filtering transactions by charge date. Defaults to the current date if not specified.","format":"date-time","additionalProperties":false,"nullable":true},"transaction_fees":{"type":"array","description":"List of transaction fee types to filter by. To get all available transaction fees, use the '/transaction-fees' endpoint.","additionalProperties":false,"items":{"type":"string","additionalProperties":false},"nullable":true},"transaction_types":{"type":"array","description":"The classification or nature of the transactions to filter by.","additionalProperties":false,"items":{"type":"string","additionalProperties":false,"enum":["Charge","Refund","Credit","Payment","BalanceAdjustment"]},"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.ChannelsV2ViewModel":{"type":"object","description":"Get Channels response","additionalProperties":false,"properties":{"items":{"type":"array","description":"List of channels","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Channels.ChannelViewModel"},"nullable":true},"next":{"type":"string","description":"Next page url","additionalProperties":false,"nullable":true},"prev":{"type":"string","description":"Previous page url","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.ErrorResponse":{"type":"object","additionalProperties":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},"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","description":"Additional key-value reference data related to this event.","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/FulfillmentCenterInventoryService.InventoryHistoryAdditionalReference"},"nullable":true},"decrement":{"description":"Details of the source location where inventory quantity decreased.","additionalProperties":false,"$ref":"#/components/schemas/FulfillmentCenterInventoryService.InventoryHistoryDetails"},"event_category":{"type":"string","description":"The type of inventory event. Supported values: `OrderPicked`, `InventoryAdjusted`, `InventoryFacilityUpdated`, `AttributeUpdated`, `InventoryReceived`, `InventoryRestocked`, `ReceivingStow`, `KittingStow`.","additionalProperties":false,"nullable":true},"event_datetime":{"type":"string","description":"The timestamp when this inventory event occurred.","format":"date-time","additionalProperties":false},"increment":{"description":"Details of the destination location where inventory quantity increased.","additionalProperties":false,"$ref":"#/components/schemas/FulfillmentCenterInventoryService.InventoryHistoryDetails"},"inventory_audit_event_id":{"type":"integer","description":"Unique identifier for this event. Use as cursor value for pagination to fetch subsequent records.","format":"int32","additionalProperties":false},"inventory_id":{"type":"integer","description":"The ShipBob inventory ID for this item.","format":"int32","additionalProperties":false},"merchant_user_id":{"type":"integer","description":"The merchant user ID associated with this inventory.","format":"int32","additionalProperties":false,"nullable":true},"shipbob_order_id":{"type":"integer","description":"The ShipBob order ID associated with this event, if applicable (e.g., for `OrderPicked` events).","format":"int32","additionalProperties":false,"nullable":true}}},"FulfillmentCenterInventoryService.InventoryHistoryAdditionalReference":{"type":"object","additionalProperties":false,"properties":{"key":{"type":"string","description":"The reference key (e.g., WRO ID, order ID, or other contextual identifier).","additionalProperties":false,"nullable":true},"value":{"type":"string","description":"The reference value corresponding to the key.","additionalProperties":false,"nullable":true}}},"FulfillmentCenterInventoryService.InventoryHistoryDetails":{"type":"object","additionalProperties":false,"properties":{"committed_quantity_change":{"type":"integer","description":"The change in committed (allocated) quantity.","format":"int32","additionalProperties":false},"expiration_date":{"type":"string","description":"The expiration date for this inventory lot, if applicable.","format":"date-time","additionalProperties":false,"nullable":true},"facility_id":{"type":"integer","description":"The fulfillment center ID where this quantity change occurred.","format":"int32","additionalProperties":false},"inventory_status":{"type":"string","description":"The current status of the inventory.","additionalProperties":false,"nullable":true},"location_id":{"type":"integer","description":"The physical shelf/bin location ID within the fulfillment center.","format":"int32","additionalProperties":false},"lot_number":{"type":"string","description":"The lot number associated with this inventory, if applicable.","additionalProperties":false,"nullable":true},"operational_stage":{"description":"The operational stage of the inventory (e.g., available, reserved, in-transit).","additionalProperties":false,"$ref":"#/components/schemas/FulfillmentCenterInventoryService.YukiOperationalStageEnumTypeResponse"},"pack_description_id":{"description":"Identifier for the packaging configuration of this inventory.","additionalProperties":false,"$ref":"#/components/schemas/FulfillmentCenterInventoryService.Ulid"},"quantity_change":{"type":"integer","description":"The change in on-hand quantity. Positive for increments, negative for decrements.","format":"int32","additionalProperties":false},"sku":{"type":"string","description":"The merchant SKU for this inventory item.","additionalProperties":false,"nullable":true},"yuki_id":{"description":"Unique identifier for the physical inventory unit (Yuki) in ShipBob's system.","additionalProperties":false,"$ref":"#/components/schemas/FulfillmentCenterInventoryService.Ulid"}}},"FulfillmentCenterInventoryService.InventoryHistoryResponse":{"type":"object","additionalProperties":false,"properties":{"data":{"type":"array","description":"Array of inventory history events matching the query criteria.","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/FulfillmentCenterInventoryService.InventoryHistory"},"nullable":true},"first":{"type":"string","description":"URL to retrieve the first page of results.","additionalProperties":false,"nullable":true},"last":{"type":"string","description":"URL to retrieve the last page of results.","additionalProperties":false,"nullable":true},"next":{"type":"string","description":"URL to retrieve the next page of results. Null if no more results available.","additionalProperties":false,"nullable":true},"prev":{"type":"string","description":"URL to retrieve the previous page of results. Null if on the first page.","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","description":"Optional. Pagination cursor using the `inventory_audit_event_id` from the previous response. Returns events after this ID.","format":"int32","additionalProperties":false,"nullable":true},"end_date":{"type":"string","description":"Optional. End date for filtering events. If omitted, defaults to current date.","format":"date-time","additionalProperties":false,"nullable":true},"event_category":{"type":"string","description":"Optional. Filter by event type: `OrderPicked`, `InventoryAdjusted`, `InventoryFacilityUpdated`, `AttributeUpdated`, `InventoryReceived`, `InventoryRestocked`, `ReceivingStow`, or `KittingStow`.","additionalProperties":false,"nullable":true},"facility_id":{"type":"integer","description":"Required. The ShipBob fulfillment center ID where the inventory events occurred.","format":"int32","additionalProperties":false},"inventory_ids":{"type":"array","description":"Optional. Filter by specific inventory IDs. Returns events for these inventories only.","additionalProperties":false,"items":{"type":"integer","format":"int32","additionalProperties":false},"nullable":true},"merchant_user_id":{"type":"integer","description":"Optional. Filter by merchant user ID. Returns events associated with this user.","format":"int32","additionalProperties":false,"nullable":true},"start_date":{"type":"string","description":"Optional. Start date for filtering events. If omitted, defaults to 90 days ago. Maximum range is 90 days.","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,"description":"Random component of the ULID (Universally Unique Lexicographically Sortable Identifier).","format":"byte","additionalProperties":false,"nullable":true},"time":{"type":"string","readOnly":true,"description":"Timestamp component of the ULID, representing when the identifier was created.","format":"date-time","additionalProperties":false}}},"FulfillmentCenterInventoryService.YukiOperationalStageEnumTypeResponse":{"type":"object","additionalProperties":false,"properties":{"description":{"type":"string","readOnly":true,"description":"Human-readable description of the operational stage (e.g., 'Available', 'Reserved', 'In Transit').","additionalProperties":false,"nullable":true},"id":{"type":"integer","readOnly":true,"description":"Numeric identifier for the operational stage.","format":"int32","additionalProperties":false}}},"Inventory.DimensionsResponse":{"type":"object","additionalProperties":false,"properties":{"height":{"type":"number","description":"Height measurement of the inventory item","format":"double","additionalProperties":false},"is_locked":{"type":"boolean","description":"Indicates whether dimensions are locked and cannot be modified","additionalProperties":false},"length":{"type":"number","description":"Length measurement of the inventory item","format":"double","additionalProperties":false},"unit":{"type":"string","description":"Unit of measurement for dimensions (i.e. inches)","additionalProperties":false,"nullable":true},"validated":{"type":"boolean","description":"Indicates whether dimensions have been validated by warehouse staff","additionalProperties":false},"width":{"type":"number","description":"Width measurement of the inventory item","format":"double","additionalProperties":false}}},"Inventory.FilterOperation":{"type":"object","additionalProperties":false,"properties":{"key":{"type":"string","description":"Filter field name to apply the operation to (e.g., 'sku', 'name', 'is_active')","additionalProperties":false,"nullable":true},"rawValue":{"type":"string","description":"Filter value to match against the specified field","additionalProperties":false,"nullable":true}}},"Inventory.FilterOperationArray":{"type":"array","description":"Advanced filtering operations. Apply multiple key-value filters to refine inventory results. Each filter operation contains a 'key' (field name) and 'rawValue' (filter value) to match.","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Inventory.FilterOperation"}},"Inventory.FulfillableQuantityByFulfillmentCenter":{"type":"object","additionalProperties":false,"properties":{"awaiting_quantity":{"type":"integer","description":"Quantity expected to arrive at this location","format":"int32","additionalProperties":false},"committed_quantity":{"type":"integer","description":"Quantity reserved for existing orders at this location","format":"int32","additionalProperties":false},"fulfillable_quantity":{"type":"integer","description":"Quantity available to fulfill new orders at this location","format":"int32","additionalProperties":false},"internal_transfer_quantity":{"type":"integer","description":"Quantity in transit to or from this location","format":"int32","additionalProperties":false},"location_id":{"type":"integer","description":"Unique identifier for the fulfillment center location","format":"int32","additionalProperties":false},"name":{"type":"string","description":"Name of the fulfillment center","additionalProperties":false,"nullable":true},"on_hand_quantity":{"type":"integer","description":"Total quantity physically present at this location","format":"int32","additionalProperties":false}}},"Inventory.FulfillmentCenterResponse":{"type":"object","additionalProperties":false,"properties":{"awaiting_quantity":{"type":"integer","description":"Quantity expected to arrive at this location","format":"int32","additionalProperties":false},"committed_quantity":{"type":"integer","description":"Quantity reserved for existing orders at this location","format":"int32","additionalProperties":false},"fulfillable_quantity":{"type":"integer","description":"Quantity available to fulfill new orders at this location","format":"int32","additionalProperties":false},"internal_transfer_quantity":{"type":"integer","description":"Quantity in transit to or from this location","format":"int32","additionalProperties":false},"location_id":{"type":"integer","description":"Unique identifier for the fulfillment center location","format":"int32","additionalProperties":false},"name":{"type":"string","description":"Name of the fulfillment center","additionalProperties":false,"nullable":true},"on_hand_quantity":{"type":"integer","description":"Total quantity physically present at this location","format":"int32","additionalProperties":false}}},"Inventory.Get.Api.V3.Inventories.InventoryId.InventoryId.Integer":{"type":"integer","description":"Unique identifier for the inventory item to retrieve. This ID is returned when listing all inventories and is used to fetch detailed information about a specific inventory item.","format":"int32","additionalProperties":false},"Inventory.Get.Api.V3.Inventories.InventoryIds.IntegerArray":{"type":"array","description":"Comma-separated list of inventory IDs to filter results. Use this to retrieve information for specific inventory items only.","additionalProperties":false,"items":{"type":"integer","format":"int32","additionalProperties":false}},"Inventory.Get.Api.V3.Inventories.IsActive.Boolean":{"type":"boolean","description":"Filter by active status. True returns only active inventory items, False returns only inactive items. Omit to return both.","additionalProperties":false},"Inventory.Get.Api.V3.Inventories.IsDigital.Boolean":{"type":"boolean","description":"Filter by digital product status. True returns only digital products (no physical fulfillment), False returns only physical products. Omit to return both.","additionalProperties":false},"Inventory.Get.Api.V3.Inventories.PageSize.Integer":{"type":"integer","description":"Number of items to return per page. Controls pagination size for the response.","format":"int32","additionalProperties":false},"Inventory.Get.Api.V3.Inventories.SearchBy.String":{"type":"string","description":"Search is available for 3 fields: Inventory ID, Name, and SKU. Expected behavior for search by Inventory ID is exact match. Expected behavior for search by Inventory Name or SKU is partial match (consecutive characters, case insensitive).","additionalProperties":false},"Inventory.Get.Api.V3.Inventories.SortBy.String":{"type":"string","description":"Sort results by field name. Default is ascending order. Prefix with '-' for descending order (e.g., '-name' sorts by name descending). Multiple fields can be comma-separated.","additionalProperties":false},"Inventory.Get.Api.V3.Inventory.Levels.InventoryId.InventoryId.Integer":{"type":"integer","description":"Unique identifier for the inventory item to retrieve quantity levels for. Use this to get aggregated inventory levels across all locations for a specific item.","format":"int32","additionalProperties":false},"Inventory.Get.Api.V3.Inventory.Levels.InventoryId.Locations.InventoryId.Integer":{"type":"integer","description":"Unique identifier for the inventory item to retrieve location-grouped quantity levels for. Use this to see inventory breakdown by fulfillment center.","format":"int32","additionalProperties":false},"Inventory.Get.Api.V3.Inventory.Levels.InventoryId.Lots.InventoryId.Integer":{"type":"integer","description":"Unique identifier for the inventory item to retrieve lot-grouped quantity levels for. Use this to see inventory breakdown by lot number and expiration date.","format":"int32","additionalProperties":false},"Inventory.Get.Api.V3.Inventory.Levels.InventoryIds.IntegerArray":{"type":"array","description":"Comma-separated list of inventory IDs to filter results. Use this to retrieve inventory levels for specific inventory items only.","additionalProperties":false,"items":{"type":"integer","format":"int32","additionalProperties":false}},"Inventory.Get.Api.V3.Inventory.Levels.IsActive.Boolean":{"type":"boolean","description":"Filter inventory levels by active status. Set to true to return only active inventory items, false for inactive items. Omit to return all items regardless of status.","additionalProperties":false},"Inventory.Get.Api.V3.Inventory.Levels.IsDigital.Boolean":{"type":"boolean","description":"Filter inventory levels by digital product status. Set to true to return only digital products, false for physical products. Digital products are items that don't require physical fulfillment.","additionalProperties":false},"Inventory.Get.Api.V3.Inventory.Levels.Locations.InventoryIds.IntegerArray":{"type":"array","description":"Comma-separated list of inventory IDs to filter results. Use this to retrieve location-grouped inventory levels for specific inventory items only.","additionalProperties":false,"items":{"type":"integer","format":"int32","additionalProperties":false}},"Inventory.Get.Api.V3.Inventory.Levels.Locations.IsActive.Boolean":{"type":"boolean","description":"Filter inventory levels by active status. Set to true to return only active inventory items, false for inactive items. Omit to return all items regardless of status.","additionalProperties":false},"Inventory.Get.Api.V3.Inventory.Levels.Locations.IsDigital.Boolean":{"type":"boolean","description":"Filter inventory levels by digital product status. Set to true to return only digital products, false for physical products. Digital products are items that don't require physical fulfillment.","additionalProperties":false},"Inventory.Get.Api.V3.Inventory.Levels.Locations.LocationId.Integer":{"type":"integer","description":"Filter by specific fulfillment center location ID. Use this to retrieve inventory levels for a particular fulfillment center.","format":"int32","additionalProperties":false},"Inventory.Get.Api.V3.Inventory.Levels.Locations.LocationType.String":{"type":"string","description":"Filter by location type. Valid values: 'hub', 'spoke', or 'lts'. Defaults to all locations if not specified.","additionalProperties":false},"Inventory.Get.Api.V3.Inventory.Levels.Locations.PageSize.Integer":{"type":"integer","description":"Number of location-grouped inventory level items to return per page. Controls pagination size for the response.","format":"int32","additionalProperties":false},"Inventory.Get.Api.V3.Inventory.Levels.Locations.SearchBy.String":{"type":"string","description":"Search is available for 3 fields: Inventory ID, Name, and SKU. Expected behavior for search by Inventory ID is exact match. Expected behavior for search by Inventory Name or SKU is partial match (consecutive characters, case insensitive).","additionalProperties":false},"Inventory.Get.Api.V3.Inventory.Levels.Locations.SortBy.String":{"type":"string","description":"Sort results by field name. Default is ascending order. Prefix with '-' for descending order (e.g., '-name' sorts by name descending). Multiple fields can be comma-separated.","additionalProperties":false},"Inventory.Get.Api.V3.Inventory.Levels.Lots.InventoryIds.IntegerArray":{"type":"array","description":"Comma-separated list of inventory IDs to filter results. Use this to retrieve lot-grouped inventory levels for specific inventory items only.","additionalProperties":false,"items":{"type":"integer","format":"int32","additionalProperties":false}},"Inventory.Get.Api.V3.Inventory.Levels.Lots.IsActive.Boolean":{"type":"boolean","description":"Filter inventory levels by active status. Set to true to return only active inventory items, false for inactive items. Omit to return all items regardless of status.","additionalProperties":false},"Inventory.Get.Api.V3.Inventory.Levels.Lots.IsDigital.Boolean":{"type":"boolean","description":"Filter inventory levels by digital product status. Set to true to return only digital products, false for physical products. Digital products are items that don't require physical fulfillment.","additionalProperties":false},"Inventory.Get.Api.V3.Inventory.Levels.Lots.LocationId.Integer":{"type":"integer","description":"Filter by specific fulfillment center location ID. Use this to retrieve lot-based inventory levels for a particular warehouse or distribution center.","format":"int32","additionalProperties":false},"Inventory.Get.Api.V3.Inventory.Levels.Lots.PageSize.Integer":{"type":"integer","description":"Number of lot-grouped inventory level items to return per page. Controls pagination size for the response.","format":"int32","additionalProperties":false},"Inventory.Get.Api.V3.Inventory.Levels.Lots.SearchBy.String":{"type":"string","description":"Search is available for 3 fields: Inventory ID, Name, and SKU. Expected behavior for search by Inventory ID is exact match. Expected behavior for search by Inventory Name or SKU is partial match (consecutive characters, case insensitive).","additionalProperties":false},"Inventory.Get.Api.V3.Inventory.Levels.Lots.SortBy.String":{"type":"string","description":"Sort results by field name. Default is ascending order. Prefix with '-' for descending order (e.g., '-lot_date' sorts by lot date descending). Multiple fields can be comma-separated.","additionalProperties":false},"Inventory.Get.Api.V3.Inventory.Levels.PageSize.Integer":{"type":"integer","description":"Number of inventory level items to return per page. Controls pagination size for the response.","format":"int32","additionalProperties":false},"Inventory.Get.Api.V3.Inventory.Levels.SearchBy.String":{"type":"string","description":"Search is available for 3 fields: Inventory ID, Name, and SKU. Expected behavior for search by Inventory ID is exact match. Expected behavior for search by Inventory Name or SKU is partial match (consecutive characters, case insensitive).","additionalProperties":false},"Inventory.Get.Api.V3.Inventory.Levels.SortBy.String":{"type":"string","description":"Sort results by field name. Default is ascending order. Prefix with '-' for descending order (e.g., '-total_on_hand_quantity' sorts by quantity descending). Multiple fields can be comma-separated.","additionalProperties":false},"Inventory.HazmatResponse":{"type":"object","additionalProperties":false,"properties":{"is_hazmat":{"type":"boolean","description":"Indicates if the inventory item is classified as hazardous material","additionalProperties":false},"validated":{"type":"boolean","description":"Indicates whether hazmat status has been validated and confirmed","additionalProperties":false}}},"Inventory.InventoryQuantityFcResponse":{"type":"object","additionalProperties":false,"properties":{"inventory_id":{"type":"integer","description":"Unique identifier for the inventory item","format":"int32","additionalProperties":false},"locations":{"type":"array","description":"List of fulfillment centers and their respective inventory quantities","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Inventory.FulfillmentCenterResponse"},"nullable":true},"name":{"type":"string","description":"Name of the inventory item","additionalProperties":false,"nullable":true},"sku":{"type":"string","description":"Stock keeping unit identifier","additionalProperties":false,"nullable":true}}},"Inventory.InventoryQuantityFcResponsePagedResponse":{"type":"object","additionalProperties":false,"properties":{"first":{"type":"string","description":"URL to retrieve the first page of results. Null if already on the first page.","additionalProperties":false,"nullable":true},"items":{"type":"array","description":"Array of location-grouped inventory quantity items in the current page of results.","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Inventory.InventoryQuantityFcResponse"},"nullable":true},"last":{"type":"string","description":"URL to retrieve the last page of results. Null if already on the last page.","additionalProperties":false,"nullable":true},"next":{"type":"string","description":"URL to retrieve the next page of results. Null if on the last page.","additionalProperties":false,"nullable":true},"prev":{"type":"string","description":"URL to retrieve the previous page of results. Null if on the first page.","additionalProperties":false,"nullable":true}}},"Inventory.InventoryQuantityLotResponse":{"type":"object","additionalProperties":false,"properties":{"inventory_id":{"type":"integer","description":"Unique identifier for the inventory item","format":"int32","additionalProperties":false},"lots":{"type":"array","description":"List of lot numbers and their respective inventory quantities","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Inventory.Lots"},"nullable":true},"name":{"type":"string","description":"Name of the inventory item","additionalProperties":false,"nullable":true},"sku":{"type":"string","description":"Stock keeping unit identifier","additionalProperties":false,"nullable":true}}},"Inventory.InventoryQuantityLotResponsePagedResponse":{"type":"object","additionalProperties":false,"properties":{"first":{"type":"string","description":"URL to retrieve the first page of results. Null if already on the first page.","additionalProperties":false,"nullable":true},"items":{"type":"array","description":"Array of lot-grouped inventory quantity items in the current page of results.","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Inventory.InventoryQuantityLotResponse"},"nullable":true},"last":{"type":"string","description":"URL to retrieve the last page of results. Null if already on the last page.","additionalProperties":false,"nullable":true},"next":{"type":"string","description":"URL to retrieve the next page of results. Null if on the last page.","additionalProperties":false,"nullable":true},"prev":{"type":"string","description":"URL to retrieve the previous page of results. Null if on the first page.","additionalProperties":false,"nullable":true}}},"Inventory.InventoryQuantityResponse":{"type":"object","additionalProperties":false,"properties":{"inventory_id":{"type":"integer","description":"Unique identifier for the inventory item","format":"int32","additionalProperties":false},"name":{"type":"string","description":"Name of the inventory item","additionalProperties":false,"nullable":true},"sku":{"type":"string","description":"Stock keeping unit identifier","additionalProperties":false,"nullable":true},"total_awaiting_quantity":{"type":"integer","description":"Total quantity expected to arrive from receiving or transfers","format":"int32","additionalProperties":false},"total_backordered_quantity":{"type":"integer","description":"Total quantity on backorder for pending shipments","format":"int32","additionalProperties":false},"total_committed_quantity":{"type":"integer","description":"Total quantity reserved for existing orders and allocations","format":"int32","additionalProperties":false},"total_exception_quantity":{"type":"integer","description":"Total quantity in exception status (damaged, lost, or under investigation)","format":"int32","additionalProperties":false},"total_fulfillable_quantity":{"type":"integer","description":"Total quantity available to fulfill new orders (on-hand minus committed)","format":"int32","additionalProperties":false},"total_internal_transfer_quantity":{"type":"integer","description":"Total quantity currently in transit between fulfillment centers","format":"int32","additionalProperties":false},"total_on_hand_quantity":{"type":"integer","description":"Total quantity physically present in all fulfillment centers","format":"int32","additionalProperties":false},"total_sellable_quantity":{"type":"integer","description":"Total quantity available for sale (fulfillable plus awaiting)","format":"int32","additionalProperties":false}}},"Inventory.InventoryQuantityResponsePagedResponse":{"type":"object","additionalProperties":false,"properties":{"first":{"type":"string","description":"URL to retrieve the first page of results. Null if already on the first page.","additionalProperties":false,"nullable":true},"items":{"type":"array","description":"Array of inventory quantity items in the current page of results.","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Inventory.InventoryQuantityResponse"},"nullable":true},"last":{"type":"string","description":"URL to retrieve the last page of results. Null if already on the last page.","additionalProperties":false,"nullable":true},"next":{"type":"string","description":"URL to retrieve the next page of results. Null if on the last page.","additionalProperties":false,"nullable":true},"prev":{"type":"string","description":"URL to retrieve the previous page of results. Null if on the first page.","additionalProperties":false,"nullable":true}}},"Inventory.InventoryResponse":{"type":"object","additionalProperties":false,"properties":{"barcode":{"type":"string","description":"Barcode associated with the inventory item","additionalProperties":false,"nullable":true},"dimensions":{"description":"Physical dimensions of the inventory item","additionalProperties":false,"$ref":"#/components/schemas/Inventory.DimensionsResponse"},"inventory_id":{"type":"integer","description":"Unique identifier for the inventory item","format":"int32","additionalProperties":false},"is_case":{"type":"boolean","description":"Indicates if the inventory item is stored in cases","additionalProperties":false},"is_lot":{"type":"boolean","description":"Indicates if the inventory item is tracked by lot number","additionalProperties":false},"name":{"type":"string","description":"Name of the inventory item","additionalProperties":false,"nullable":true},"sku":{"type":"string","description":"Stock keeping unit identifier","additionalProperties":false,"nullable":true},"user_id":{"type":"integer","description":"User ID associated with this inventory item","format":"int32","additionalProperties":false},"variant":{"description":"Variant details including active status and product characteristics","additionalProperties":false,"$ref":"#/components/schemas/Inventory.VariantResponse"},"weight":{"description":"Weight information of the inventory item","additionalProperties":false,"$ref":"#/components/schemas/Inventory.WeightResponse"}}},"Inventory.InventoryResponsePagedResponse":{"type":"object","additionalProperties":false,"properties":{"first":{"type":"string","description":"URL to retrieve the first page of results. Null if already on the first page.","additionalProperties":false,"nullable":true},"items":{"type":"array","description":"Array of inventory items in the current page of results.","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Inventory.InventoryResponse"},"nullable":true},"last":{"type":"string","description":"URL to retrieve the last page of results. Null if already on the last page.","additionalProperties":false,"nullable":true},"next":{"type":"string","description":"URL to retrieve the next page of results. Null if on the last page.","additionalProperties":false,"nullable":true},"prev":{"type":"string","description":"URL to retrieve the previous page of results. Null if on the first page.","additionalProperties":false,"nullable":true}}},"Inventory.Lots":{"type":"object","additionalProperties":false,"properties":{"awaiting_quantity":{"type":"integer","description":"Quantity expected to arrive for this lot","format":"int32","additionalProperties":false},"committed_quantity":{"type":"integer","description":"Quantity reserved for existing orders from this lot","format":"int32","additionalProperties":false},"fulfillable_quantity":{"type":"integer","description":"Quantity available to fulfill new orders for this lot","format":"int32","additionalProperties":false},"internal_transfer_quantity":{"type":"integer","description":"Quantity in transit between locations for this lot","format":"int32","additionalProperties":false},"locations":{"type":"array","description":"Breakdown of lot quantities by fulfillment center location","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Inventory.FulfillableQuantityByFulfillmentCenter"},"nullable":true},"lot_date":{"type":"string","description":"Expiration or manufacturing date associated with this lot","format":"date-time","additionalProperties":false,"nullable":true},"lot_number":{"type":"string","description":"Unique lot or batch number for this inventory grouping","additionalProperties":false,"nullable":true},"on_hand_quantity":{"type":"integer","description":"Total quantity physically present for this lot","format":"int32","additionalProperties":false}}},"Inventory.ProblemDetails":{"type":"object","additionalProperties":{"additionalProperties":false},"properties":{"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem.","additionalProperties":false,"nullable":true},"instance":{"type":"string","description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","additionalProperties":false,"nullable":true},"status":{"type":"integer","description":"The HTTP status code for this occurrence of the problem.","format":"int32","additionalProperties":false,"nullable":true},"title":{"type":"string","description":"A short, human-readable summary of the problem type.","additionalProperties":false,"nullable":true},"type":{"type":"string","description":"A URI reference that identifies the problem type. This URI should provide human-readable documentation for the problem.","additionalProperties":false,"nullable":true}}},"Inventory.VariantResponse":{"type":"object","additionalProperties":false,"properties":{"hazmat":{"description":"Hazardous materials information","additionalProperties":false,"$ref":"#/components/schemas/Inventory.HazmatResponse"},"is_active":{"type":"boolean","description":"Indicates if the variant is currently active and available for fulfillment","additionalProperties":false},"is_bundle":{"type":"boolean","description":"Indicates if this item is a bundle of multiple products","additionalProperties":false},"is_digital":{"type":"boolean","description":"Indicates if this is a digital product (no physical fulfillment required)","additionalProperties":false}}},"Inventory.WeightResponse":{"type":"object","additionalProperties":false,"properties":{"unit":{"type":"string","description":"Unit of measurement for weight (e.g., pounds, kilograms)","additionalProperties":false,"nullable":true},"value":{"type":"number","description":"Weight value of the inventory item","format":"double","additionalProperties":false}}},"Locations.AddressViewModel":{"type":"object","description":"The service-specific address of the location. Each object contains address type, address1, address2, city, state, country, zip code, phone number, and email","additionalProperties":false,"properties":{"address1":{"type":"string","description":"First part of the address of the location for this service","additionalProperties":false,"nullable":true},"address2":{"type":"string","description":"Second part of the address of the location for this service","additionalProperties":false,"nullable":true},"city":{"type":"string","description":"City of the location","additionalProperties":false,"nullable":true},"country":{"type":"string","description":"Country of the location","additionalProperties":false,"nullable":true},"email":{"type":"string","description":"Email of the location for this service","additionalProperties":false,"nullable":true},"name":{"type":"string","description":"Name to use in the address of the location for this service","additionalProperties":false,"nullable":true},"phone_number":{"type":"string","description":"Phone Number of the location for this service","additionalProperties":false,"nullable":true},"state":{"type":"string","description":"State of the location","additionalProperties":false,"nullable":true},"zip_code":{"type":"string","description":"Zip code of the location","additionalProperties":false,"nullable":true}}},"Locations.FcAttributeViewModel":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","description":"Unique Id for the fulfillment center attribute","format":"int32","additionalProperties":false},"name":{"type":"string","description":"Name of the attribute.","additionalProperties":false,"nullable":true}}},"Locations.FcTypeViewModel":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","description":"Unique Id for the fulfillment center type","format":"int32","additionalProperties":false},"name":{"type":"string","description":"Name of the fc type","additionalProperties":false,"nullable":true}}},"Locations.FcTypeViewModelV2":{"type":"object","additionalProperties":false,"properties":{"organization_roles":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Locations.OrganizationRoleViewModel"},"nullable":true},"organization_type_id":{"type":"string","format":"uuid","additionalProperties":false},"organization_type_name":{"type":"string","additionalProperties":false,"nullable":true}},"allOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Locations.FcTypeViewModel"}]},"Locations.FulfillmentCenterNameViewModel":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","description":"Unique Id for the fulfillment center","format":"int32","additionalProperties":false},"name":{"type":"string","description":"Name for the fulfillment center","additionalProperties":false,"nullable":true}}},"Locations.FulfillmentCenterRegionViewModel":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","description":"Unique Id for the location region","format":"int32","additionalProperties":false},"name":{"type":"string","description":"Name of the region the location is in.","additionalProperties":false,"nullable":true}}},"Locations.Get.1.0.Location.AccessGranted.Boolean":{"type":"boolean","description":"Return all the access granted locations","additionalProperties":false,"nullable":true},"Locations.Get.1.0.Location.IncludeInactive.Boolean":{"type":"boolean","description":"Whether the inactive locations should be included or not","additionalProperties":false,"nullable":true},"Locations.Get.1.0.Location.OK.OneOfArray":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Locations.LocationViewModel"}},"Locations.Get.1.0.Location.ReceivingEnabled.Boolean":{"type":"boolean","description":"Return all the receiving enabled locations","additionalProperties":false,"nullable":true},"Locations.InternalLocationViewModel":{"type":"object","additionalProperties":false,"properties":{"fulfillment_center_attributes":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Locations.FcAttributeViewModel"},"nullable":true},"fulfillment_center_type":{"additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Locations.FcTypeViewModel"},{"additionalProperties":false,"$ref":"#/components/schemas/Locations.FcTypeViewModelV2"}],"nullable":true},"is_enabled_for_new_user":{"type":"boolean","additionalProperties":false},"is_external":{"type":"boolean","additionalProperties":false}},"allOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Locations.LocationViewModel"}]},"Locations.InternalLocationViewModelV2":{"type":"object","additionalProperties":false,"properties":{"fulfillment_center_attributes":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Locations.FcAttributeViewModel"},"nullable":true},"fulfillment_center_type":{"additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Locations.FcTypeViewModel"},{"additionalProperties":false,"$ref":"#/components/schemas/Locations.FcTypeViewModelV2"}],"nullable":true},"is_enabled_for_new_user":{"type":"boolean","additionalProperties":false},"max_sku_allowed":{"type":"integer","format":"int32","additionalProperties":false,"nullable":true},"receiving_hub":{"additionalProperties":false,"$ref":"#/components/schemas/Locations.FulfillmentCenterNameViewModel"},"sort_center":{"additionalProperties":false,"$ref":"#/components/schemas/Locations.FulfillmentCenterNameViewModel"}},"allOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Locations.LocationViewModelV2"}]},"Locations.LocationViewModel":{"type":"object","additionalProperties":false,"properties":{"abbreviation":{"type":"string","description":"Abbreviation of the location. Combination of nearest Airport Code and the sequence number.","additionalProperties":false,"nullable":true},"access_granted":{"type":"boolean","description":"Indicates whether or not the user is authorized to interact at all with the location","additionalProperties":false},"attributes":{"type":"array","description":"Available attributes for the location","additionalProperties":false,"items":{"type":"string","additionalProperties":false},"nullable":true},"id":{"type":"integer","description":"Id of the location in ShipBob’s database","format":"int32","additionalProperties":false},"is_active":{"type":"boolean","description":"Indicates if the location is operationally active or inactive","additionalProperties":false},"is_receiving_enabled":{"type":"boolean","description":"Indicates if the receiving is enabled for FC","additionalProperties":false},"is_shipping_enabled":{"type":"boolean","description":"Indicates if the shipping is enabled for FC","additionalProperties":false},"name":{"type":"string","description":"Name of the location. Follows the naming convention City (State Code)\r\nfor domestic FCs and City (Country Code) for international FCs","additionalProperties":false,"nullable":true},"region":{"additionalProperties":false,"$ref":"#/components/schemas/Locations.FulfillmentCenterRegionViewModel"},"services":{"type":"array","description":"Services provided by the location","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Locations.ServiceViewModel"},"nullable":true},"timezone":{"type":"string","description":"Time zone of the location","additionalProperties":false,"nullable":true}}},"Locations.LocationViewModelV2":{"type":"object","additionalProperties":false,"properties":{"organization_id":{"type":"string","format":"uuid","additionalProperties":false},"owner_id":{"type":"string","format":"uuid","additionalProperties":false,"nullable":true},"parent_id":{"type":"string","format":"uuid","additionalProperties":false,"nullable":true}},"allOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Locations.LocationViewModel"}]},"Locations.OrganizationRoleViewModel":{"type":"object","additionalProperties":false,"properties":{"description":{"type":"string","additionalProperties":false,"nullable":true},"id":{"type":"string","format":"uuid","additionalProperties":false},"name":{"type":"string","additionalProperties":false,"nullable":true}}},"Locations.ServiceTypeEnum":{"type":"string","additionalProperties":false,"enum":["Receiving","Returns"]},"Locations.ServiceViewModel":{"type":"object","additionalProperties":false,"properties":{"address":{"additionalProperties":false,"$ref":"#/components/schemas/Locations.AddressViewModel"},"enabled":{"type":"boolean","description":"Indicates if the user is authorized to access this service at the location","additionalProperties":false},"service_type":{"additionalProperties":false,"$ref":"#/components/schemas/Locations.ServiceTypeEnum"}}},"Orders.AddProductToOrderByProductIdModel":{"type":"object","additionalProperties":false,"required":["product_id","id","quantity"],"properties":{"external_line_id":{"type":"integer","description":"Numeric assignment per item. Used as a reference number for multiple purposes such as split orders, split containers, etc.","format":"int32","additionalProperties":false,"nullable":true},"id":{"type":"integer","description":"Unique id of the product","format":"int32","additionalProperties":false},"quantity":{"type":"integer","description":"The quantity of this product ordered","format":"int32","additionalProperties":false},"quantity_unit_of_measure_code":{"type":"string","description":"Defined standard for measure for an item (each, inner pack, case, pallet).  Values: EA, INP, CS and PL","additionalProperties":false,"nullable":true}},"allOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Orders.AddProductToOrderModel"}]},"Orders.AddProductToOrderByReferenceIdModel":{"type":"object","additionalProperties":false,"required":["quantity","reference_id","name"],"properties":{"external_line_id":{"type":"integer","description":"Numeric assignment per item. Used as a reference number for multiple purposes such as split orders, split containers, etc.","format":"int32","additionalProperties":false,"nullable":true},"gtin":{"type":"string","description":"Global Trade Item Number - unique and internationally recognized identifier assigned to item by company GS1","maxLength":50,"minLength":0,"additionalProperties":false,"nullable":true},"name":{"type":"string","description":"Name of the product. Required if there is not an existing ShipBob product with a matching reference_id value.","example":"TShirtBlueM","additionalProperties":false,"nullable":true},"quantity":{"type":"integer","description":"The quantity of this product ordered","format":"int32","additionalProperties":false},"quantity_unit_of_measure_code":{"type":"string","description":"Defined standard for measure for an item (each, inner pack, case, pallet).  Values: EA, INP, CS and PL","additionalProperties":false,"nullable":true},"reference_id":{"type":"string","description":"Unique reference id (also known as sku or seller_sku) of the product.","minLength":1,"example":"TShirtBlueM","additionalProperties":false},"sku":{"type":"string","description":"Product SKU","additionalProperties":false,"nullable":true},"unit_price":{"type":"number","description":"Price for one item","format":"double","additionalProperties":false,"nullable":true},"upc":{"type":"string","description":"Universal Product Code - Unique external identifier","maxLength":50,"minLength":0,"additionalProperties":false,"nullable":true}},"allOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Orders.AddProductToOrderModel"}]},"Orders.AddProductToOrderModel":{"type":"object","additionalProperties":false,"properties":{"external_line_id":{"type":"integer","description":"Numeric assignment per item. Used as a reference number for multiple purposes such as split orders, split containers, etc.","format":"int32","additionalProperties":false,"nullable":true},"quantity":{"type":"integer","format":"int32","maximum":2147483647.0,"minimum":1.0,"additionalProperties":false},"quantity_unit_of_measure_code":{"type":"string","description":"Defined standard for measure for an item (each, inner pack, case, pallet).  Values: EA, INP, CS and PL","additionalProperties":false,"nullable":true}}},"Orders.AddStoreOrderJsonModel":{"type":"object","description":"Model for adding a Store Order Json to a ShipBob Order.","example":{"order_json":"string"},"additionalProperties":false,"required":["orderJson"],"properties":{"order_json":{"type":"string","description":"Json String that represent the order on a store front system","minLength":1,"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.BulkUpdateResponseError":{"type":"object","additionalProperties":false,"properties":{"code":{"type":"string","additionalProperties":false,"nullable":true},"message":{"type":"string","additionalProperties":false,"nullable":true}}},"Orders.BulkUpdateResponseModel":{"type":"object","additionalProperties":false,"properties":{"results":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.BulkUpdateResponseResult"},"nullable":true},"summary":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.BulkUpdateResponseSummary"}}},"Orders.BulkUpdateResponseResult":{"type":"object","additionalProperties":false,"properties":{"error":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.BulkUpdateResponseError"},"isSuccess":{"type":"boolean","additionalProperties":false},"shipmentId":{"type":"integer","format":"int64","additionalProperties":false}}},"Orders.BulkUpdateResponseSummary":{"type":"object","additionalProperties":false,"properties":{"failed":{"type":"integer","format":"int32","additionalProperties":false},"successful":{"type":"integer","format":"int32","additionalProperties":false},"total":{"type":"integer","format":"int32","additionalProperties":false}}},"Orders.BulkUpdateTrackingUploadModel":{"type":"object","description":"Model for updating tracking upload status for multiple shipments","example":{"is_tracking_uploaded":true,"shipment_ids":[100810005]},"additionalProperties":false,"properties":{"is_tracking_uploaded":{"type":"boolean","description":"Indicates whether the Shipment was marked with tracking information\r\nuploaded to a third-party system where the order originated.\r\nApplies to all shipments in shipment_ids","additionalProperties":false},"shipment_ids":{"type":"array","description":"Shipment IDs to apply the tracking upload status to","additionalProperties":false,"items":{"type":"integer","format":"int32","additionalProperties":false},"nullable":true}}},"Orders.CancelShipmentsModel":{"type":"object","description":"Model for cancel multiple shipments at once","example":{"shipment_ids":[0]},"additionalProperties":false,"properties":{"shipment_ids":{"type":"array","description":"Shipment IDs to cancel","additionalProperties":false,"items":{"type":"integer","format":"int32","additionalProperties":false},"nullable":true}}},"Orders.CanceledOrderViewModel":{"type":"object","description":"","additionalProperties":false,"properties":{"canceled_shipment_results":{"type":"array","description":"Results of canceling the shipments associated with the order","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.CanceledShipmentViewModel"},"nullable":true},"order":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.OrderViewModel"},"order_id":{"type":"integer","description":"The ID of the canceled order","format":"int32","additionalProperties":false},"status":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.CancellationResult"}}},"Orders.CanceledShipmentViewModel":{"type":"object","description":"","additionalProperties":false,"properties":{"action":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.ShipmentAction"},"is_success":{"type":"boolean","description":"If the cancel action was successful","additionalProperties":false},"reason":{"type":"string","description":"The reason the cancellation result","additionalProperties":false,"nullable":true},"shipment_id":{"type":"integer","description":"The ID of the shipment","format":"int64","additionalProperties":false}}},"Orders.CanceledShipmentsViewModel":{"type":"object","description":"","additionalProperties":false,"properties":{"results":{"type":"array","description":"The results of all cancellation actions","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.CanceledShipmentViewModel"},"nullable":true}}},"Orders.CancellationResult":{"type":"string","additionalProperties":false,"enum":["Success","Failure","PartialSuccess"]},"Orders.CarrierShipType":{"type":"string","additionalProperties":false,"enum":["Parcel","Freight"]},"Orders.CartonDetailsViewModel":{"type":"object","additionalProperties":false,"properties":{"products":{"type":"array","description":"List of what is packed in this carton","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.ShipmentProductViewModel"},"nullable":true}}},"Orders.CartonMeasurementsViewModel":{"type":"object","description":"Measurements of a carton","additionalProperties":false,"properties":{"depth_in":{"type":"number","description":"Total depth in inches","format":"double","additionalProperties":false},"length_in":{"type":"number","description":"Total length in inches","format":"double","additionalProperties":false},"total_weight_oz":{"type":"number","description":"Total weight in ounces","format":"double","additionalProperties":false},"width_in":{"type":"number","description":"Total width in inches","format":"double","additionalProperties":false}}},"Orders.CartonViewModel":{"type":"object","additionalProperties":false,"properties":{"barcode":{"type":"string","description":"Barcode assigned to this carton","additionalProperties":false,"nullable":true},"carton_details":{"type":"array","description":"Details about the contents of this carton","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.CartonDetailsViewModel"},"nullable":true},"id":{"type":"integer","description":"ID assigned to this carton","format":"int32","additionalProperties":false},"measurements":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.CartonMeasurementsViewModel"},"type":{"type":"string","description":"Type of this carton container","example":"Box or pallet","additionalProperties":false,"nullable":true}}},"Orders.ChannelInfoViewModel":{"type":"object","description":"Created by channel metadata","additionalProperties":false,"properties":{"id":{"type":"integer","description":"Unique id of the channel","format":"int32","additionalProperties":false},"name":{"type":"string","description":"Name of the channel","example":"ShipBobs-Shopify-Store","additionalProperties":false,"nullable":true}}},"Orders.CreateOrderModel":{"type":"object","example":{"financials":{"total_price":0.1},"gift_message":"string","location_id":0,"order_number":"string","products":[{"external_line_id":0,"id":0,"quantity":1,"quantity_unit_of_measure_code":"string"}],"purchase_date":"2019-08-24T14:15:22Z","recipient":{"address":{"address1":"100 Nowhere Blvd","address2":"Suite 100","city":"Gotham City","company_name":"Wayne Enterprises","country":"US","state":"NJ","zip_code":"07093"},"email":"john@example.com","name":"John Doe","phone_number":"555-555-5555"},"reference_id":"string","retailer_program_data":{"addresses":[{"address1":"100 Nowhere Blvd","address2":"Suite 100","city":"Gotham City","company_name":"Wayne Enterprises","country":"US","state":"NJ","type":"MarkFor","zip_code":"07093"}],"customer_ticket_number":"string","delivery_date":"2019-08-24T14:15:22Z","department":"string","doNotShipBeforeDate":"2019-08-24T14:15:22Z","mark_for_store":"string","purchase_order_number":"string","retailer_program_type":"string","shipByDate":"2019-08-24T14:15:22Z"},"shipping_method":"Free 2-day Shipping","shipping_terms":{"carrier_type":"Parcel","payment_term":"Collect"},"tags":[{"name":"Handling instructions","value":"Fragile"}],"type":"DTC"},"additionalProperties":false,"required":["products","recipient","reference_id","shipping_method","type"],"properties":{"financials":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.Financials"},"gift_message":{"type":"string","description":"Gift message associated with the order","maxLength":500,"additionalProperties":false,"nullable":true},"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,"nullable":true},"order_number":{"type":"string","description":"User friendly orderId or store order number that will be shown on the Orders Page. If not provided, referenceId will be used","maxLength":400,"additionalProperties":false,"nullable":true},"origin_platform_program":{"type":"string","description":"Origin platform program for the order. Accepts a program name.","maxLength":100,"example":"FBM","additionalProperties":false,"nullable":true},"products":{"type":"array","description":"Products included in the order. Products identified by reference_id must also include the product name if there is no matching ShipBob product.","minItems":1,"additionalProperties":false,"items":{"additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Orders.AddProductToOrderByReferenceIdModel"},{"additionalProperties":false,"$ref":"#/components/schemas/Orders.AddProductToOrderByProductIdModel"}]}},"purchase_date":{"type":"string","description":"Date this order was purchase by the end user","format":"date-time","additionalProperties":false,"nullable":true},"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},"requested_delivery_date":{"type":"string","description":"The delivery date requested by the source platform for the order in UTC","format":"date-time","additionalProperties":false,"nullable":true},"retailer_program_data":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.RetailerProgramDataViewModel"},"sales_channel":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.SalesChannel"},"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},"shipping_terms":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.ShippingTermsViewModel"},"tags":{"type":"array","description":"Key value pair array to store extra information at the order level for API purposes. ShipBob won't display the info in the ShipBob Merchant Portal or react based on this data.","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.TagViewModel"},"nullable":true},"type":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.OrderType"}}},"Orders.EstimateDetailViewModel":{"type":"object","additionalProperties":false,"properties":{"estimated_currency_code":{"type":"string","description":"Estimated local currency code","additionalProperties":false,"nullable":true},"estimated_price":{"type":"number","description":"Estimated price in dollars for the provided shipping method","format":"double","additionalProperties":false},"fulfillment_center":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.FulfillmentCenterViewModel"},"shipping_method":{"type":"string","description":"Provided shipping method. Maps to ship option in ShipBob.","additionalProperties":false,"nullable":true},"total_weight_oz":{"type":"number","description":"Total weight of items in cart including packaging.","format":"double","additionalProperties":false}}},"Orders.EstimateFulfillmentRequestModel":{"type":"object","example":{"address":{"address1":"100 Nowhere Blvd","address2":"Suite 100","city":"Gotham City","company_name":"Wayne Enterprises","country":"US","state":"NJ","zip_code":"07093"},"products":[{"id":0,"quantity":1,"reference_id":"TShirtBlueM"}],"shipping_methods":["string"]},"additionalProperties":false,"required":["address","products"],"properties":{"address":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.EstimationAddressViewModel"},"products":{"type":"array","description":"Products to be included in the order. Each product must include one of reference_id or id","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.EstimateProductInfoModel"}},"shipping_methods":{"type":"array","description":"Array of strings specifying shipping methods for which to fetch estimates.\r\n\r\nIf this field is omitted we will return estimates for all shipping methods defined in ShipBob","additionalProperties":false,"items":{"type":"string","additionalProperties":false},"nullable":true}}},"Orders.EstimateProductInfoModel":{"type":"object","additionalProperties":false,"required":["quantity"],"properties":{"id":{"type":"integer","description":"Unique id of the product (Must be provided if reference_id is unknown)","format":"int32","additionalProperties":false,"nullable":true},"quantity":{"type":"integer","description":"The quantity of this product ordered","format":"int32","maximum":199.0,"minimum":1.0,"additionalProperties":false},"reference_id":{"type":"string","description":"Unique reference id of the product (Must be provided if ID is unknown)","example":"TShirtBlueM","additionalProperties":false,"nullable":true}}},"Orders.EstimateViewModel":{"type":"object","additionalProperties":false,"properties":{"estimates":{"type":"array","description":"Array of estimates for each shipping method","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.EstimateDetailViewModel"},"nullable":true}}},"Orders.EstimationAddressViewModel":{"type":"object","additionalProperties":false,"required":["country"],"properties":{"address1":{"type":"string","description":"First line of the address","example":"100 Nowhere Blvd","additionalProperties":false,"nullable":true},"address2":{"type":"string","description":"Second line of the address","example":"Suite 100","additionalProperties":false,"nullable":true},"city":{"type":"string","description":"The city","example":"Gotham City","additionalProperties":false,"nullable":true},"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.Financials":{"type":"object","additionalProperties":false,"properties":{"total_price":{"type":"number","description":"Sum of all line item prices, discounts, and taxes in USD","format":"double","additionalProperties":false,"nullable":true}}},"Orders.FulfillmentCenterViewModel":{"type":"object","description":"Information about a fulfillment center that a shipment can belong to","additionalProperties":false,"properties":{"id":{"type":"integer","description":"Id of the fulfillment center","format":"int32","additionalProperties":false},"name":{"type":"string","description":"Name of the fulfillment center","example":"Cicero (IL)","additionalProperties":false,"nullable":true}}},"Orders.FulfillmentStatus":{"type":"string","additionalProperties":false,"enum":["AwaitingInventoryAllocation","AwaitingReset","Unavailable","PendingOnTime","FulfilledOnTime","PendingLate","FulfilledLate"]},"Orders.Get.Api.Order.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},"Orders.Get.Api.Order.Cancelled.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},"Orders.Get.Api.Order.Cancelled.IsTrackingUploaded.Boolean":{"type":"boolean","additionalProperties":false},"Orders.Get.Api.Order.Cancelled.Limit.Integer":{"type":"integer","format":"int32","maximum":250.0,"minimum":1.0,"additionalProperties":false},"Orders.Get.Api.Order.Cancelled.Page.Integer":{"type":"integer","format":"int32","maximum":2147483647.0,"minimum":1.0,"additionalProperties":false},"Orders.Get.Api.Order.EndDate.String":{"type":"string","format":"date-time","additionalProperties":false},"Orders.Get.Api.Order.HasTracking.Boolean":{"type":"boolean","additionalProperties":false},"Orders.Get.Api.Order.IDs.IntegerArray":{"type":"array","additionalProperties":false,"items":{"type":"integer","format":"int32","additionalProperties":false}},"Orders.Get.Api.Order.IsTrackingUploaded.Boolean":{"type":"boolean","additionalProperties":false},"Orders.Get.Api.Order.LastTrackingUpdateEndDate.String":{"type":"string","format":"date-time","additionalProperties":false},"Orders.Get.Api.Order.LastTrackingUpdateStartDate.String":{"type":"string","format":"date-time","additionalProperties":false},"Orders.Get.Api.Order.LastUpdateEndDate.String":{"type":"string","format":"date-time","additionalProperties":false},"Orders.Get.Api.Order.LastUpdateStartDate.String":{"type":"string","format":"date-time","additionalProperties":false},"Orders.Get.Api.Order.Limit.Integer":{"type":"integer","format":"int32","maximum":250.0,"minimum":1.0,"additionalProperties":false},"Orders.Get.Api.Order.OrderId.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},"Orders.Get.Api.Order.OrderId.OrderId.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Orders.Get.Api.Order.OrderId.Shipbob.Channel.Id.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Orders.Get.Api.Order.OrderId.Shipment.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},"Orders.Get.Api.Order.OrderId.Shipment.OK.OneOfArray":{"type":"array","additionalProperties":false,"items":{"description":"Information about a shipment","additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Orders.ShipmentViewModel"},{"additionalProperties":false,"$ref":"#/components/schemas/Orders.InternalShipmentViewModel"}]}},"Orders.Get.Api.Order.OrderId.Shipment.OrderId.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Orders.Get.Api.Order.OrderId.Shipment.Shipbob.Channel.Id.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},"Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.Logs.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},"Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.Logs.OrderId.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.Logs.Shipbob.Channel.Id.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.Logs.ShipmentId.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.OK.OneOf.ShipmentViewModel.InternalShipmentViewModel":{"description":"Information about a shipment","additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Orders.ShipmentViewModel"},{"additionalProperties":false,"$ref":"#/components/schemas/Orders.InternalShipmentViewModel"}]},"Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.OrderId.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.Shipbob.Channel.Id.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.ShipmentId.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.Timeline.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},"Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.Timeline.OrderId.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.Timeline.Shipbob.Channel.Id.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Orders.Get.Api.Order.OrderId.Shipment.ShipmentId.Timeline.ShipmentId.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Orders.Get.Api.Order.OrderId.StoreOrderJson.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},"Orders.Get.Api.Order.OrderId.StoreOrderJson.OK.String":{"type":"string","additionalProperties":false},"Orders.Get.Api.Order.OrderId.StoreOrderJson.OrderId.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Orders.Get.Api.Order.OrderId.StoreOrderJson.Unprocessable.Entity.Object":{"type":"object","additionalProperties":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},"Orders.Get.Api.Order.Page.Integer":{"type":"integer","format":"int32","maximum":2147483647.0,"minimum":1.0,"additionalProperties":false},"Orders.Get.Api.Order.ReferenceIds.StringArray":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}},"Orders.Get.Api.Order.Shipbob.Channel.Id.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Orders.Get.Api.Order.StartDate.String":{"type":"string","format":"date-time","additionalProperties":false},"Orders.Get.Api.Shipment.ListByStatus.AsOfStatusDate.String":{"type":"string","format":"date-time","additionalProperties":false},"Orders.Get.Api.Shipment.ListByStatus.Limit.Integer":{"type":"integer","format":"int32","maximum":2147483647.0,"minimum":1.0,"additionalProperties":false},"Orders.Get.Api.Shipment.ListByStatus.Page.Integer":{"type":"integer","format":"int32","maximum":2147483647.0,"minimum":1.0,"additionalProperties":false},"Orders.Get.Api.Shipment.ListByStatus.Shipbob.Channel.Id.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Orders.Get.Api.Shipment.PickedNotShippedInventory.FulfillmentCenterId.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Orders.Get.Api.Shipment.PickedNotShippedInventory.Shipbob.Channel.Id.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Orders.Get.Api.Shipment.ShipmentId.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},"Orders.Get.Api.Shipment.ShipmentId.Logs.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},"Orders.Get.Api.Shipment.ShipmentId.Logs.Shipbob.Channel.Id.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Orders.Get.Api.Shipment.ShipmentId.Logs.ShipmentId.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Orders.Get.Api.Shipment.ShipmentId.OK.OneOf.ShipmentViewModel.InternalShipmentViewModel":{"description":"Information about a shipment","additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Orders.ShipmentViewModel"},{"additionalProperties":false,"$ref":"#/components/schemas/Orders.InternalShipmentViewModel"}]},"Orders.Get.Api.Shipment.ShipmentId.Shipbob.Channel.Id.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Orders.Get.Api.Shipment.ShipmentId.ShipmentId.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Orders.Get.Api.Shipment.ShipmentId.Timeline.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},"Orders.Get.Api.Shipment.ShipmentId.Timeline.Shipbob.Channel.Id.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Orders.Get.Api.Shipment.ShipmentId.Timeline.ShipmentId.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Orders.Get.Api.Shippingmethod.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},"Orders.Get.Api.Shippingmethod.Limit.Integer":{"type":"integer","format":"int32","maximum":250.0,"minimum":1.0,"additionalProperties":false},"Orders.Get.Api.Shippingmethod.Page.Integer":{"type":"integer","format":"int32","maximum":2147483647.0,"minimum":0.0,"additionalProperties":false},"Orders.Get.Api.Shippingmethod.Unprocessable.Entity.Object":{"type":"object","additionalProperties":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},"Orders.InternalShipmentViewModel":{"type":"object","additionalProperties":false,"properties":{"store_order_id":{"type":"string","description":"Unique store order id of the shipment","additionalProperties":false,"nullable":true}},"allOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Orders.ShipmentViewModel"}]},"Orders.InventoryPickedNotShippedViewModel":{"type":"object","additionalProperties":false,"properties":{"expiration_date":{"type":"string","description":"Expiration date of the inventory","format":"date-time","additionalProperties":false,"nullable":true},"fulfillment_center_id":{"type":"integer","format":"int32","additionalProperties":false},"inventory_id":{"type":"integer","format":"int32","additionalProperties":false},"lot_number":{"type":"string","description":"Lot number of the inventory","example":"22222","additionalProperties":false,"nullable":true},"name":{"type":"string","additionalProperties":false,"nullable":true},"quantity":{"type":"integer","format":"int32","additionalProperties":false},"sku":{"type":"string","additionalProperties":false,"nullable":true}}},"Orders.InventoryPickedNotShippedViewModelArray":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.InventoryPickedNotShippedViewModel"}},"Orders.InventoryViewModel":{"type":"object","description":"Information about inventory belonging to a store product","additionalProperties":false,"properties":{"expiration_date":{"type":"string","description":"Expiration date of the inventory","format":"date-time","additionalProperties":false,"nullable":true},"id":{"type":"integer","description":"Unique id of the inventory","format":"int32","additionalProperties":false},"is_dangerous_goods":{"type":"boolean","description":"Is inventory Dangerous Good","example":true,"additionalProperties":false},"lot":{"type":"string","description":"Lot number of the inventory","example":"22222","additionalProperties":false,"nullable":true},"name":{"type":"string","description":"Name of the inventory item","example":"Medium Blue T-Shirt","additionalProperties":false,"nullable":true},"quantity":{"type":"integer","description":"Quantity of the inventory item to be included in the fulfillment","format":"int32","additionalProperties":false},"quantity_committed":{"type":"integer","description":"The quantity of the inventory item allocated from the assigned fulfillment center and committed to the order. If quantity committed is less than order quantity, then the inventory item is out of stock at the assigned fulfillment center.","format":"int32","additionalProperties":false},"serial_numbers":{"type":"array","description":"Serial number of the inventory","additionalProperties":false,"items":{"type":"string","additionalProperties":false},"nullable":true}}},"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.OrderShipmentIdsViewModel":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","description":"Unique id of the order","format":"int64","additionalProperties":false},"order_number":{"type":"string","description":"User-friendly orderId or store order number that will be shown on the Orders Page. If not provided, referenceId\r\nwill be used","additionalProperties":false,"nullable":true},"shipment_ids":{"type":"array","description":"Shipments Ids affiliated with the order","additionalProperties":false,"items":{"type":"integer","format":"int64","additionalProperties":false},"nullable":true}}},"Orders.OrderShipmentIdsViewModelArray":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.OrderShipmentIdsViewModel"}},"Orders.OrderStatus":{"type":"string","additionalProperties":false,"enum":["Processing","Exception","PartiallyFulfilled","Fulfilled","Cancelled","ImportReview"]},"Orders.OrderStatusEnum":{"type":"string","additionalProperties":false,"enum":["None","Processing","Completed","Exception","OnHold","Cancelled","CleanSweeped","LabeledCreated","ImportReview"]},"Orders.OrderType":{"type":"string","additionalProperties":false,"enum":["DTC","DropShip","B2B"]},"Orders.OrderVerifyAndSaveAddressRequest":{"type":"object","description":"Request model for verify and save address for order","additionalProperties":false,"required":["city","streetAddress1"],"properties":{"CountryCode":{"type":"string","description":"Country code of customer address","additionalProperties":false,"nullable":true},"IsDomestic":{"type":"boolean","description":"IsDomestic flag","additionalProperties":false},"IsPoBox":{"type":"boolean","description":"IsPoBox flag","additionalProperties":false},"IsValid":{"type":"boolean","description":"IsValid flag","additionalProperties":false},"OrderId":{"type":"integer","description":"OrderId","format":"int32","additionalProperties":false},"OverrideVerification":{"type":"boolean","description":"Override Verification Flag","additionalProperties":false},"PhoneNumber":{"type":"string","description":"Phonenumber of customer address","additionalProperties":false,"nullable":true},"StreetAddress1":{"type":"string","description":"Street Address 1","minLength":1,"additionalProperties":false},"StreetAddress2":{"type":"string","description":"Streed Address 2","additionalProperties":false,"nullable":true},"ZipCode":{"type":"string","description":"Zipcode of customer address","additionalProperties":false,"nullable":true},"city":{"type":"string","description":"City of customer address","minLength":1,"additionalProperties":false},"email":{"type":"string","description":"Customer's email address","additionalProperties":false,"nullable":true},"name":{"type":"string","description":"Name of customer","additionalProperties":false,"nullable":true},"state":{"type":"string","description":"State of customer address","additionalProperties":false,"nullable":true}}},"Orders.OrderViewModel":{"type":"object","additionalProperties":false,"properties":{"channel":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.ChannelInfoViewModel"},"created_date":{"type":"string","description":"Date this order was created","format":"date-time","additionalProperties":false},"financials":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.Financials"},"gift_message":{"type":"string","description":"Gift message associated with the order","additionalProperties":false,"nullable":true},"id":{"type":"integer","description":"Unique id of the order","format":"int32","additionalProperties":false},"order_number":{"type":"string","description":"User friendly orderId or store order number that will be shown on the Orders Page. If not provided, referenceId will be used","additionalProperties":false,"nullable":true},"products":{"type":"array","description":"List of products included in the order","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.ProductInfoViewModel"},"nullable":true},"purchase_date":{"type":"string","description":"Date this order was purchase by the end user","format":"date-time","additionalProperties":false,"nullable":true},"recipient":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.RecipientInfoViewModel"},"reference_id":{"type":"string","description":"Client-defined external unique id of the order","additionalProperties":false,"nullable":true},"retailer_program_data":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.RetailerProgramDataViewModel"},"shipments":{"type":"array","description":"Shipments affiliated with the order","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.ShipmentViewModel"},"nullable":true},"shipping_method":{"type":"string","description":"Client-defined shipping method","example":"Free 2-day Shipping","additionalProperties":false,"nullable":true},"shipping_terms":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.ShippingTermsViewModel"},"status":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.OrderStatus"},"tags":{"type":"array","description":"Client-defined order tags","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.TagViewModel"},"nullable":true},"type":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.OrderType"}}},"Orders.OrderViewModelArray":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.OrderViewModel"}},"Orders.PackageMaterialType":{"type":"string","additionalProperties":false,"enum":["Unknown","Box","BubbleMailer","PolyMailer","FragileBox","PosterTube","Custom","Bookfold","OwnContainer","Undefined"]},"Orders.ParentCartonViewModel":{"type":"object","additionalProperties":false,"properties":{"barcode":{"type":"string","description":"Barcode assigned to this carton","additionalProperties":false,"nullable":true},"cartons":{"type":"array","description":"Cartons packed inside this parent container","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.CartonViewModel"},"nullable":true},"measurements":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.CartonMeasurementsViewModel"},"type":{"type":"string","description":"Type of this carton container","example":"Box or pallet","additionalProperties":false,"nullable":true}}},"Orders.PaymentShipTerm":{"type":"string","additionalProperties":false,"enum":["Collect","ThirdParty","Prepaid","MerchantResponsible"]},"Orders.Post.Api.Order.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},"Orders.Post.Api.Order.Estimate.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},"Orders.Post.Api.Order.Estimate.Shipbob.Channel.Id.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Orders.Post.Api.Order.Estimate.Unprocessable.Entity.Object":{"type":"object","additionalProperties":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},"Orders.Post.Api.Order.OrderId.Cancel.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},"Orders.Post.Api.Order.OrderId.Cancel.Internal.Server.Error.Object":{"type":"object","additionalProperties":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},"Orders.Post.Api.Order.OrderId.Cancel.OrderId.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Orders.Post.Api.Order.OrderId.Cancel.Shipbob.Channel.Id.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Orders.Post.Api.Order.OrderId.Cancel.Unprocessable.Entity.Object":{"type":"object","additionalProperties":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},"Orders.Post.Api.Order.OrderId.Shipment.ShipmentId.Cancel.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},"Orders.Post.Api.Order.OrderId.Shipment.ShipmentId.Cancel.Internal.Server.Error.Object":{"type":"object","additionalProperties":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},"Orders.Post.Api.Order.OrderId.Shipment.ShipmentId.Cancel.OK.OneOf.ShipmentViewModel.InternalShipmentViewModel":{"description":"Information about a shipment","additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Orders.ShipmentViewModel"},{"additionalProperties":false,"$ref":"#/components/schemas/Orders.InternalShipmentViewModel"}]},"Orders.Post.Api.Order.OrderId.Shipment.ShipmentId.Cancel.OrderId.String":{"type":"string","additionalProperties":false},"Orders.Post.Api.Order.OrderId.Shipment.ShipmentId.Cancel.Shipbob.Channel.Id.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Orders.Post.Api.Order.OrderId.Shipment.ShipmentId.Cancel.ShipmentId.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Orders.Post.Api.Order.OrderId.Shipment.ShipmentId.Cancel.Unprocessable.Entity.Object":{"type":"object","additionalProperties":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},"Orders.Post.Api.Order.OrderId.StoreOrderJson.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},"Orders.Post.Api.Order.OrderId.StoreOrderJson.Created.String":{"type":"string","additionalProperties":false},"Orders.Post.Api.Order.OrderId.StoreOrderJson.OrderId.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Orders.Post.Api.Order.OrderId.StoreOrderJson.Unprocessable.Entity.Object":{"type":"object","additionalProperties":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},"Orders.Post.Api.Order.Shipbob.Channel.Id.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Orders.Post.Api.Order.Unprocessable.Entity.Object":{"type":"object","additionalProperties":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},"Orders.Post.Api.Shipment.BulkUpdateTrackingUpload.Bad.Request.String":{"type":"string","additionalProperties":false},"Orders.Post.Api.Shipment.Cancelbulk.Internal.Server.Error.Object":{"type":"object","additionalProperties":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},"Orders.Post.Api.Shipment.Cancelbulk.Shipbob.Channel.Id.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Orders.Post.Api.Shipment.Cancelbulk.Unprocessable.Entity.Object":{"type":"object","additionalProperties":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},"Orders.Post.Api.Shipment.ShipmentId.Cancel.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},"Orders.Post.Api.Shipment.ShipmentId.Cancel.Internal.Server.Error.Object":{"type":"object","additionalProperties":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},"Orders.Post.Api.Shipment.ShipmentId.Cancel.OK.OneOf.ShipmentViewModel.InternalShipmentViewModel":{"description":"Information about a shipment","additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Orders.ShipmentViewModel"},{"additionalProperties":false,"$ref":"#/components/schemas/Orders.InternalShipmentViewModel"}]},"Orders.Post.Api.Shipment.ShipmentId.Cancel.Shipbob.Channel.Id.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Orders.Post.Api.Shipment.ShipmentId.Cancel.ShipmentId.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Orders.Post.Api.Shipment.ShipmentId.Cancel.Unprocessable.Entity.Object":{"type":"object","additionalProperties":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},"Orders.ProductInfoViewModel":{"type":"object","additionalProperties":false,"properties":{"external_line_id":{"type":"integer","description":"Numeric assignment per item. Used as a reference number for multiple purposes such as split orders, split containers, etc.","format":"int32","additionalProperties":false,"nullable":true},"gtin":{"type":"string","description":"Global Trade Item Number - unique and internationally recognized identifier assigned to item by company GS1","additionalProperties":false,"nullable":true},"id":{"type":"integer","description":"Unique id of the product","format":"int32","additionalProperties":false,"nullable":true},"quantity":{"type":"integer","description":"The quantity of this product ordered","format":"int32","additionalProperties":false},"quantity_unit_of_measure_code":{"type":"string","description":"Defined standard for measure for an item (each, inner pack, case, pallet).  Values: EA, INP, CS and PL","additionalProperties":false,"nullable":true},"reference_id":{"type":"string","description":"Unique reference id of the product","example":"TShirtBlueM","additionalProperties":false,"nullable":true},"sku":{"type":"string","description":"Stock keeping unit for the product","example":"TShirtBlueM","additionalProperties":false,"nullable":true},"unit_price":{"type":"number","description":"Price for one item","format":"double","additionalProperties":false,"nullable":true},"upc":{"type":"string","description":"Universal Product Code - Unique external identifier","additionalProperties":false,"nullable":true}}},"Orders.Put.Api.Shipment.ShipmentId.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},"Orders.Put.Api.Shipment.ShipmentId.OK.OneOfArray":{"type":"array","additionalProperties":false,"items":{"description":"Information about a shipment","additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Orders.ShipmentViewModel"},{"additionalProperties":false,"$ref":"#/components/schemas/Orders.InternalShipmentViewModel"}]}},"Orders.Put.Api.Shipment.ShipmentId.Shipbob.Channel.Id.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Orders.Put.Api.Shipment.ShipmentId.ShipmentId.Integer":{"type":"integer","format":"int32","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.RecipientViewModel":{"type":"object","description":"Information about the recipient of a shipment","additionalProperties":false,"properties":{"address":{"description":"Address of the recipient","additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Orders.AddressViewModel"},{"additionalProperties":false,"$ref":"#/components/schemas/Orders.RetailerProgramDataAddressViewModel"}],"nullable":true},"email":{"type":"string","description":"Email address of the recipient","format":"email","example":"john@example.com","additionalProperties":false,"nullable":true},"full_name":{"type":"string","description":"FullName of the recipient","example":"John Doe","additionalProperties":false,"nullable":true},"name":{"type":"string","description":"Name of the recipient","example":"John Doe","additionalProperties":false,"nullable":true},"phone_number":{"type":"string","description":"Phone number of the recipient","format":"tel","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.RetailerProgramDataViewModel":{"type":"object","description":"Contains properties that needs to be used for fulfilling B2B/Dropship orders.","additionalProperties":false,"required":["purchaseOrderNumber","retailerProgramType"],"properties":{"addresses":{"type":"array","description":"Ship From - Certain retailers want to display the ship from address as their return facility, not Shipbob’s warehouse address        /// \r\nMark For Address - Final destination address","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.RetailerProgramDataAddressViewModel"},"nullable":true},"customer_ticket_number":{"type":"string","description":"Customer Ticket Number","additionalProperties":false,"nullable":true},"delivery_date":{"type":"string","description":"Expected delivery date","format":"date-time","additionalProperties":false,"nullable":true},"department":{"type":"string","description":"Identifies a merchant's store department","additionalProperties":false,"nullable":true},"doNotShipBeforeDate":{"type":"string","description":"The date the retailer does not want the order shipped by.","format":"date-time","additionalProperties":false,"nullable":true},"mark_for_store":{"type":"string","description":"Store Number","additionalProperties":false,"nullable":true},"purchase_order_number":{"type":"string","description":"First initial documentation sent from buyer to seller with item(s) and quantities.","minLength":1,"additionalProperties":false},"retailer_program_type":{"type":"string","description":"Identifies retailer-merchant combination","minLength":1,"additionalProperties":false},"shipByDate":{"type":"string","description":"The date the retailer has requested the order to ship by.","format":"date-time","additionalProperties":false,"nullable":true}}},"Orders.SalesChannel":{"type":"string","additionalProperties":false,"enum":["amazon","bigcommerce","ebay","faire","macy","magento","shein","shopify","squarespace","targetplus","temu","tiktok","unleashed","walmart","woocommerce"]},"Orders.ServiceLevelDetailViewModel":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","description":"Unique id for the service level","format":"int32","additionalProperties":false},"name":{"type":"string","description":"The name or title of the service level","additionalProperties":false,"nullable":true}}},"Orders.ShipMethodDetailViewModel":{"type":"object","additionalProperties":false,"properties":{"active":{"type":"boolean","description":"Indicates if the shipping method is active","additionalProperties":false},"default":{"type":"boolean","description":"Indicates the shipping method is a ShipBob default shipping method.","additionalProperties":false},"id":{"type":"integer","description":"Unique id for shipping method.","format":"int32","additionalProperties":false},"name":{"type":"string","description":"Name of the ship method as selected by the merchant and saved in ShipBob’s database (i.e. “ground”). Corresponds to the shipping_method field in the Orders API.","additionalProperties":false,"nullable":true},"service_level":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.ServiceLevelDetailViewModel"}}},"Orders.ShipMethodDetailViewModelArray":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.ShipMethodDetailViewModel"}},"Orders.ShipmentAction":{"type":"string","additionalProperties":false,"enum":["CleanSweep","Reassign","ReleaseOrderHold","MoveToOnHoldAndKeepInventory","MoveToOnHoldAndReleaseInventory","Cancel","AddLineItem","RemoveLineItem","UpdateShipOption"]},"Orders.ShipmentLogViewModel":{"type":"object","additionalProperties":false,"properties":{"log_type_id":{"type":"integer","description":"Log type id of the shipment","format":"int32","additionalProperties":false},"log_type_name":{"type":"string","description":"Name of the log type","additionalProperties":false,"nullable":true},"log_type_text":{"type":"string","description":"Summary of log type meaning","additionalProperties":false,"nullable":true},"metadata":{"type":"object","description":"Specifics data for the event","additionalProperties":{"type":"string","additionalProperties":false,"nullable":true},"nullable":true},"timestamp":{"type":"string","description":"Timestamp of event","format":"date-time","additionalProperties":false}}},"Orders.ShipmentLogViewModelArray":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.ShipmentLogViewModel"}},"Orders.ShipmentProductViewModel":{"type":"object","description":"Information about a store product belonging to a shipment","additionalProperties":false,"properties":{"id":{"type":"integer","description":"Unique id of the product","format":"int32","additionalProperties":false},"inventory_items":{"type":"array","description":"Information about fulfillable inventory items belonging to this product","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.InventoryViewModel"},"nullable":true},"name":{"type":"string","description":"Name of the product","example":"Medium Blue T-Shirt","additionalProperties":false,"nullable":true},"reference_id":{"type":"string","description":"Unique reference id of the product","example":"TShirtBlueM","additionalProperties":false,"nullable":true},"sku":{"type":"string","description":"Stock keeping unit for the product","example":"TShirtBlueM","additionalProperties":false,"nullable":true}}},"Orders.ShipmentStatusFilter":{"type":"string","additionalProperties":false,"enum":["Processing","OnHold","Exception","Picked","Packed","Shipped","InTransit","Delivered","DeliveryException"]},"Orders.ShipmentStatusViewModel":{"type":"object","additionalProperties":false,"properties":{"location_id":{"type":"integer","description":"Unique ShipBob Id of the Fulfillment Center to which the shipment was assigned","format":"int32","additionalProperties":false},"order_id":{"type":"integer","description":"Unique ShipBob Id of the parent order","format":"int64","additionalProperties":false},"reference_id":{"type":"string","description":"The Reference Id ingested with the original order","additionalProperties":false,"nullable":true},"shipment_id":{"type":"integer","description":"Unique ShipBob Id of the shipment","format":"int32","additionalProperties":false},"status_datetime":{"type":"string","description":"Datetime when the shipment entered into the requested status (according to request filters)","format":"date-time","additionalProperties":false},"store_order_id":{"type":"string","description":"The Store Order Id ingested with the original order","additionalProperties":false,"nullable":true},"store_order_tags":{"type":"string","description":"The raw tag data ingested with the original store order","additionalProperties":false,"nullable":true}}},"Orders.ShipmentStatusViewModelArray":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.ShipmentStatusViewModel"}},"Orders.ShipmentViewModel":{"type":"object","description":"Information about a shipment","additionalProperties":false,"properties":{"actual_fulfillment_date":{"type":"string","description":"The datetime of ShipBob’s completion of the fulfillment operation as promised.\r\nCurrently, this means the shipment has been picked, packed, and label has been printed.","format":"date-time","additionalProperties":false,"nullable":true},"created_date":{"type":"string","description":"Date this shipment was created","format":"date-time","additionalProperties":false},"delivery_date":{"type":"string","description":"The datetime of Shipment delivered to customer.","format":"date-time","additionalProperties":false,"nullable":true},"estimated_fulfillment_date":{"type":"string","description":"The datetime of ShipBob’s commitment for completing\r\nthe shipment and handing to the carrier for delivery.","format":"date-time","additionalProperties":false,"nullable":true},"estimated_fulfillment_date_status":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.FulfillmentStatus"},"gift_message":{"type":"string","description":"Gift message associated with the shipment","maxLength":500,"additionalProperties":false,"nullable":true},"id":{"type":"integer","description":"Unique id of the shipment","format":"int32","additionalProperties":false},"insurance_value":{"type":"number","description":"Monetary amount that this shipment was insured for","format":"currency","additionalProperties":false,"nullable":true},"invoice_amount":{"type":"number","description":"Monetary amount that was invoiced for this shipment","format":"currency","additionalProperties":false,"nullable":true},"invoice_currency_code":{"type":"string","additionalProperties":false,"nullable":true},"is_tracking_uploaded":{"type":"boolean","description":"Indicates whether the Shipment was marked with tracking information\r\nuploaded to a third-party system where the order originated.","additionalProperties":false},"last_tracking_update_at":{"type":"string","description":"Timestamp for the last time this shipment had a tracking update","format":"date-time","additionalProperties":false,"nullable":true},"last_update_at":{"type":"string","description":"Date this shipment was last updated","format":"date-time","additionalProperties":false,"nullable":true},"location":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.FulfillmentCenterViewModel"},"measurements":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.MeasurementsViewModel"},"order_id":{"type":"integer","description":"Id of the order this shipment belongs to","format":"int32","additionalProperties":false},"package_material_type":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.PackageMaterialType"},"parent_cartons":{"type":"array","description":"Carton information for this shipment","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.ParentCartonViewModel"},"nullable":true},"products":{"type":"array","description":"Information about the products contained in this shipment","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.ShipmentProductViewModel"},"nullable":true},"recipient":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.RecipientViewModel"},"reference_id":{"type":"string","description":"Client-defined external unique id of the order this shipment belongs to","additionalProperties":false,"nullable":true},"require_signature":{"type":"boolean","description":"If a shipment requires signature","additionalProperties":false},"ship_option":{"type":"string","description":"Name of the shipping option used for this shipment","example":"Standard","additionalProperties":false,"nullable":true},"status":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.OrderStatusEnum"},"status_details":{"type":"array","description":"Additional details about the shipment status","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.StatusDetailViewModel"},"nullable":true},"tracking":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.TrackingViewModel"}}},"Orders.ShippingTermsViewModel":{"type":"object","description":"Contains shipping properties that need to be used for fulfilling an order.","additionalProperties":false,"properties":{"carrier_type":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.CarrierShipType"},"payment_term":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.PaymentShipTerm"}}},"Orders.SortOrder":{"type":"string","additionalProperties":false,"enum":["Newest","Oldest"]},"Orders.StatusDetailViewModel":{"type":"object","additionalProperties":false,"properties":{"description":{"type":"string","description":"Describes what the status detail means","additionalProperties":false,"nullable":true},"exception_fulfillment_center_id":{"type":"integer","format":"int32","additionalProperties":false,"nullable":true},"extra_information":{"additionalProperties":false,"$ref":"#/components/schemas/Orders.StatusInformationViewModel"},"id":{"type":"integer","description":"The id of the status detail","format":"int32","additionalProperties":false},"inventory_id":{"type":"integer","description":"Inventory Id the detail applies to (if applicable)","format":"int32","additionalProperties":false,"nullable":true},"name":{"type":"string","description":"Short name of the status detail","additionalProperties":false,"nullable":true}}},"Orders.StatusInformationViewModel":{"type":"object","additionalProperties":false,"properties":{"validation_messages":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false},"nullable":true}}},"Orders.TagViewModel":{"type":"object","additionalProperties":false,"required":["name","value"],"properties":{"name":{"type":"string","description":"The key of the tag","maxLength":50,"minLength":1,"example":"Handling instructions","additionalProperties":false},"value":{"type":"string","description":"The value of the tag","maxLength":500,"minLength":1,"example":"Fragile","additionalProperties":false}}},"Orders.TrackingViewModel":{"type":"object","description":"Tracking information for a shipment","additionalProperties":false,"properties":{"bol":{"type":"string","description":"Bill of lading (BOL) number. Document acknowledging receipt of cargo for shipment.","additionalProperties":false,"nullable":true},"carrier":{"type":"string","description":"Carrier of the shipment","example":"USPS","additionalProperties":false,"nullable":true},"carrier_service":{"type":"string","description":"The carrier's service which was used for this shipment","example":"Priority","additionalProperties":false,"nullable":true},"pro_number":{"type":"string","description":"Tracking number used for freight carriers","additionalProperties":false,"nullable":true},"scac":{"type":"string","description":"Standard Carrier Alpha Code (SCAC). Unique 2-4 letter code used to identify transportation companies.","additionalProperties":false,"nullable":true},"shipping_date":{"type":"string","description":"Date freight was shipped on","format":"date-time","additionalProperties":false,"nullable":true},"tracking_number":{"type":"string","description":"Tracking number of the shipment","example":"860C8CDC8F0B4FC7AB69AC86C20539EC","additionalProperties":false,"nullable":true},"tracking_url":{"type":"string","description":"URL to the website where a shipment can be tracked","example":"https://www.example.com/tracking?id=860C8CDC8F0B4FC7AB69AC86C20539EC","additionalProperties":false,"nullable":true}}},"Orders.UpdateShipmentModel":{"type":"object","description":"Model for Updating multiple shipments of the same Order","additionalProperties":false,"properties":{"is_tracking_uploaded":{"type":"boolean","description":"Indicates whether the Shipment was marked with tracking information\r\nuploaded to a third-party system where the order originated.","additionalProperties":false}}},"Products.AdditionalHazmatAttributesRequestModel":{"type":"object","additionalProperties":false,"properties":{"charge_state_percentage":{"type":"number","format":"double","additionalProperties":false,"nullable":true},"container_metal":{"type":"boolean","additionalProperties":false,"deprecated":true,"nullable":true},"container_type":{"type":"string","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,"deprecated":true,"nullable":true},"container_type":{"type":"string","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","description":"URL to download or view a printable barcode sticker","additionalProperties":false,"nullable":true},"value":{"type":"string","description":"The barcode value (e.g., UPC, EAN, GTIN, or other barcode format)","additionalProperties":false,"nullable":true}}},"Products.BarcodeViewModel":{"type":"object","additionalProperties":false,"properties":{"sticker_url":{"type":"string","description":"URL to download or view a printable barcode sticker","additionalProperties":false,"nullable":true},"value":{"type":"string","description":"The barcode value (e.g., UPC, EAN, GTIN, or other barcode format)","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,"deprecated":true,"nullable":true},"container_type":{"type":"string","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","description":"Height of the product in inches","format":"double","additionalProperties":false},"length":{"type":"number","description":"Length of the product in inches","format":"double","additionalProperties":false},"width":{"type":"number","description":"Width of the product in inches","format":"double","additionalProperties":false}}},"Products.BaseFulfillmentSettingsModel":{"type":"object","additionalProperties":false,"properties":{"dangerous_goods":{"type":"boolean","description":"Flag indicating whether the product is classified as dangerous goods (hazmat) requiring special handling","additionalProperties":false},"is_bpm_parcel":{"type":"boolean","description":"Flag indicating whether this product qualifies for Business Parcel Manager (BPM) parcel shipping","additionalProperties":false},"is_case_pick":{"type":"boolean","description":"Flag indicating whether this product should be picked by the case rather than individual units","additionalProperties":false},"msds_url":{"type":"string","description":"URL to the Material Safety Data Sheet (MSDS) for hazardous materials","additionalProperties":false,"nullable":true},"requires_prop65":{"type":"boolean","description":"Flag indicating California Proposition 65 warning label requirement for products containing chemicals known to cause cancer or reproductive harm","additionalProperties":false},"serial_scan":{"description":"Serial number scanning configuration for tracking individual units","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","description":"The name of the product","additionalProperties":false,"nullable":true},"taxonomy_id":{"type":"integer","description":"The taxonomy ID for categorizing the product","format":"int32","additionalProperties":false,"nullable":true},"type_id":{"type":"integer","description":"The product type ID (1 = Regular, 2 = Bundle)","format":"int32","example":1,"additionalProperties":false,"enum":[1,2]}}},"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":{"description":"Additional hazardous material attributes for variants containing lithium batteries or other regulated materials","additionalProperties":false,"$ref":"#/components/schemas/Products.AdditionalHazmatAttributesRequestModel"},"bundle_definition":{"type":"array","description":"For bundle products, defines which variants and quantities make up the bundle","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Products.BundleDefinitionRequestModel"},"nullable":true},"channel_metadata":{"type":"array","description":"Channel-specific metadata for different sales platforms (Amazon, Shopify, BigCommerce, etc.)","additionalProperties":false,"items":{"additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.BaseChannelMetadataRequestModel"}]},"nullable":true},"customs":{"description":"Customs information for international shipping including HS tariff code, country of origin, and declared value","additionalProperties":false,"$ref":"#/components/schemas/Products.CustomsRequestModel"},"dimension":{"description":"The physical dimensions (length, width, height) of the variant","additionalProperties":false,"$ref":"#/components/schemas/Products.DimensionRequestModel"},"fulfillment_settings":{"description":"Fulfillment settings including Prop 65 requirements, dangerous goods, serial scanning, and case pick settings","additionalProperties":false,"$ref":"#/components/schemas/Products.FulfillmentSettingsRequestModel"},"gtin":{"type":"string","description":"The Global Trade Item Number (GTIN) for the variant","additionalProperties":false,"nullable":true},"is_digital":{"type":"boolean","description":"Indicates whether this is a digital product that requires no physical fulfillment","additionalProperties":false},"lot_information":{"description":"Lot tracking information including whether the variant is lot-tracked and minimum shelf life","additionalProperties":false,"$ref":"#/components/schemas/Products.LotInformationRequestModel"},"name":{"type":"string","description":"The name of the variant","additionalProperties":false,"nullable":true},"packaging_material_type_id":{"type":"integer","description":"The ID of the packaging material type (e.g., Box, Envelope, Poly Mailer)","format":"int32","additionalProperties":false,"nullable":true},"packaging_requirement_id":{"type":"integer","description":"The ID of the packaging requirement for the variant (e.g., IsFragile, RequiresBubbleWrap)","format":"int32","additionalProperties":false,"nullable":true},"return_preferences":{"description":"Return handling preferences including primary and backup actions for returns","additionalProperties":false,"$ref":"#/components/schemas/Products.ReturnPreferencesRequestModel"},"sku":{"type":"string","description":"The unique stock keeping unit (SKU) for the variant","additionalProperties":false,"nullable":true},"status_id":{"type":"integer","description":"The status ID of the variant (0 = Active, 1 = Inactive)","format":"int32","additionalProperties":false,"enum":[0,1]},"upc":{"type":"string","description":"The Universal Product Code (UPC) for the variant","additionalProperties":false,"nullable":true},"weight":{"type":"number","description":"The weight of the variant in ounces","format":"double","additionalProperties":false}}},"Products.BaseReturnPreferencesModel":{"type":"object","additionalProperties":false,"properties":{"backup_action_id":{"type":"integer","description":"ID of backup action to take if primary action cannot be completed","format":"int32","additionalProperties":false,"nullable":true},"instructions":{"type":"string","description":"Special instructions for handling returned items","additionalProperties":false,"nullable":true},"primary_action_id":{"type":"integer","description":"ID of primary action to take when product is returned by customer (e.g., Restock, Dispose, Return to Sender)","format":"int32","additionalProperties":false},"return_to_sender_backup_action_id":{"type":"integer","description":"ID of backup action for undeliverable packages if primary action cannot be completed","format":"int32","additionalProperties":false,"nullable":true},"return_to_sender_primary_action_id":{"type":"integer","description":"ID of primary action for undeliverable packages that are returned to sender","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","description":"Unique identifier for the taxonomy node","format":"int32","additionalProperties":false},"name":{"type":"string","description":"Display name of the taxonomy category","additionalProperties":false,"nullable":true},"path":{"type":"string","description":"Full hierarchical path of the taxonomy (e.g., 'Electronics > Computers > Laptops')","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.ComplianceViewModel":{"type":"object","additionalProperties":false,"properties":{"category":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false},"nullable":true},"reasons":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false},"nullable":true},"status":{"type":"string","additionalProperties":false,"nullable":true}}},"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.CreateProductRequestModelV5":{"type":"object","example":{"is_quarantine":true,"name":"string","taxonomy_id":0,"type_id":0,"variants":[{"additional_hazmat_attributes":{"charge_state_percentage":0.1,"container_metal":true,"container_type":"string","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":{"is_quarantine":{"type":"boolean","description":"Flag indicating whether the product should be created in quarantine status","additionalProperties":false},"variants":{"type":"array","description":"List of variants to create with the product. At least one variant is required. Each variant must have a unique SKU.","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Products.CreateProductVariantRequestModelV5"},"nullable":true}},"allOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.BaseProductRequestModel"}]},"Products.CreateProductVariantRequestModelV5":{"type":"object","additionalProperties":false,"properties":{"barcodes":{"type":"array","description":"Array of barcode values for the variant","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,"container_type":"string","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","description":"ISO 3166-1 alpha-2 country code where the product was manufactured (e.g., 'US', 'CN', 'MX')","additionalProperties":false,"nullable":true},"description":{"type":"string","description":"Product description for customs documentation","additionalProperties":false,"nullable":true},"hs_tariff_code":{"type":"string","description":"Harmonized System tariff code used for international customs classification (6-10 digits)","additionalProperties":false,"nullable":true},"is321_eligible":{"type":"boolean","description":"Flag indicating eligibility for Section 321 de minimis exemption (imports under $800 to US)","additionalProperties":false},"value":{"type":"integer","description":"Declared customs value of the product for international shipping","format":"int32","additionalProperties":false,"nullable":true}}},"Products.CustomsViewModel":{"type":"object","additionalProperties":false,"properties":{"country_code_of_origin":{"type":"string","description":"ISO 3166-1 alpha-2 country code where the product was manufactured (e.g., 'US', 'CN', 'MX')","additionalProperties":false,"nullable":true},"currency":{"type":"string","description":"ISO 4217 currency code for the declared value (e.g., 'USD', 'EUR', 'GBP')","additionalProperties":false,"nullable":true},"description":{"type":"string","description":"Product description for customs documentation","additionalProperties":false,"nullable":true},"hs_tariff_code":{"type":"string","description":"Harmonized System tariff code used for international customs classification (6-10 digits)","additionalProperties":false,"nullable":true},"is321_eligible":{"type":"boolean","description":"Flag indicating eligibility for Section 321 de minimis exemption (imports under $800 to US)","additionalProperties":false},"value":{"type":"integer","description":"Declared customs value of the product for international shipping","format":"int32","additionalProperties":false,"nullable":true}}},"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.OK.OneOf.VariantViewModelV5.VariantInternalViewModelV5":{"additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.VariantViewModelV5"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.VariantInternalViewModelV5"}]},"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","description":"Height of the product","format":"double","additionalProperties":false},"is_locked":{"type":"boolean","description":"Flag indicating whether dimensions are locked and cannot be automatically recalculated by the system","additionalProperties":false},"length":{"type":"number","description":"Length of the product","format":"double","additionalProperties":false},"source":{"type":"string","description":"Source of the dimension data (e.g., 'User', 'System', 'Warehouse')","additionalProperties":false,"nullable":true},"unit":{"type":"string","description":"Unit of measurement for dimensions (e.g., 'in', 'cm')","additionalProperties":false,"nullable":true},"width":{"type":"number","description":"Width of the product","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","description":"Flag indicating whether the product is classified as dangerous goods (hazmat) requiring special handling","additionalProperties":false},"is_bpm_parcel":{"type":"boolean","description":"Flag indicating whether this product qualifies for Business Parcel Manager (BPM) parcel shipping","additionalProperties":false},"is_case_pick":{"type":"boolean","description":"Flag indicating whether this product should be picked by the case rather than individual units","additionalProperties":false},"msds_url":{"type":"string","description":"URL to the Material Safety Data Sheet (MSDS) for hazardous materials","additionalProperties":false,"nullable":true},"requires_prop65":{"type":"boolean","description":"Flag indicating California Proposition 65 warning label requirement for products containing chemicals known to cause cancer or reproductive harm","additionalProperties":false},"serial_scan":{"description":"Serial number scanning configuration for tracking individual units","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.V5.Product.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},"Products.Get.Api.V5.Product.Barcode.Int":{"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.Barcodes.List.String":{"description":"Barcodes Associated with variant","additionalProperties":false},"Products.Get.Api.V5.Product.CategoryIds.List.Int":{"description":"List of Category Ids associated with product","additionalProperties":false},"Products.Get.Api.V5.Product.ChannelIds.List.Int":{"description":"Looks for Products variants by their channel IDs","additionalProperties":false},"Products.Get.Api.V5.Product.HasDigitalVariants.Boolean":{"description":"Looks for Products with/without digital variants","additionalProperties":false},"Products.Get.Api.V5.Product.HasVariants.Boolean":{"description":"Looks for Products with/without variants","additionalProperties":false},"Products.Get.Api.V5.Product.InventoryId.List.Int":{"description":"Looks for variants by its associated inventory id","additionalProperties":false},"Products.Get.Api.V5.Product.LastUpdatedTimestamp.DateTime":{"description":"Looks for Products that have been updated since the given date","additionalProperties":false},"Products.Get.Api.V5.Product.LegacyIds.List.Int":{"description":"Looks for Products with by Legacy Product Id(s)","additionalProperties":false},"Products.Get.Api.V5.Product.Name.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":{"description":"Looks for Products with inventory","additionalProperties":false},"Products.Get.Api.V5.Product.PageSize.Int":{"additionalProperties":false},"Products.Get.Api.V5.Product.PlatformIds.List.String":{"description":"Looks for Products variants by their external Platform IDs","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":{"description":"Looks for Products with an assigned Id","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.OK.OneOfArray":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.VariantViewModelV5"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.VariantInternalViewModelV5"}]}},"Products.Get.Api.V5.Product.ProductId.Variants.ProductId.Integer":{"type":"integer","format":"int64","additionalProperties":false},"Products.Get.Api.V5.Product.ProductType.Integer":{"description":"Looks for Products by type","additionalProperties":false},"Products.Get.Api.V5.Product.ReviewsPending.List.ReviewsPendingType":{"description":"Looks for Products by ReviewsPending","additionalProperties":false},"Products.Get.Api.V5.Product.SKU.String":{"description":"Looks for Products that match the provided Sku query","additionalProperties":false},"Products.Get.Api.V5.Product.SalesChannel.List.String":{"description":"Looks for Products variants assigned to a platform/sales channel ","additionalProperties":false},"Products.Get.Api.V5.Product.Search.String":{"type":"string","additionalProperties":false},"Products.Get.Api.V5.Product.SellerSKU.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":{"description":"Looks for Products variants by their taxonomy id or any descendants of the taxonomies sent separated by comma","additionalProperties":false},"Products.Get.Api.V5.Product.VariantId.List.Int":{"description":"Looks for products that contain a variant with the given ID","additionalProperties":false},"Products.Get.Api.V5.Product.VariantStatus.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","description":"List of product categories where this packaging requirement is applicable","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Products.ApplicableCategoryViewModel"},"nullable":true},"applicable_packaging_material_types":{"type":"array","description":"List of packaging material types that are compatible with this requirement","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Products.PackagingMaterialTypeViewModel"},"nullable":true},"applicable_taxonomy":{"type":"array","description":"List of taxonomy paths where this packaging requirement can be applied","additionalProperties":false,"items":{"type":"string","additionalProperties":false},"nullable":true},"description":{"type":"string","description":"Detailed explanation of the packaging requirement and when it should be used","additionalProperties":false,"nullable":true},"id":{"type":"integer","description":"Unique identifier for the packaging requirement","format":"int32","additionalProperties":false},"name":{"type":"string","description":"Display name of the packaging requirement (e.g., 'Poly Bag', 'Bubble Wrap')","additionalProperties":false,"nullable":true}}},"Products.PackagingRequirementViewModelArray":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Products.PackagingRequirementViewModel"}},"Products.Patch.Api.V5.Product.ProductId.ProductId.Integer":{"type":"integer","format":"int64","additionalProperties":false},"Products.Patch.Api.V5.Product.ProductId.Variants.OK.OneOfArray":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.VariantViewModelV5"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.VariantInternalViewModelV5"}]}},"Products.Patch.Api.V5.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,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.VariantViewModel"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.VariantInternalViewModel"}]},"nullable":true}}},"Products.ProductViewModelV5":{"type":"object","additionalProperties":false,"properties":{"created_on":{"type":"string","description":"Timestamp when the product was created","format":"date-time","additionalProperties":false},"id":{"type":"integer","description":"Unique identifier for the product","format":"int64","additionalProperties":false},"name":{"type":"string","description":"Product name","additionalProperties":false,"nullable":true},"taxonomy":{"description":"Product categorization information including category hierarchy","additionalProperties":false,"$ref":"#/components/schemas/Products.TaxonomyInformationViewModel"},"type":{"type":"string","description":"Product type (e.g., 'Regular' or 'Bundle')","additionalProperties":false,"nullable":true},"updated_on":{"type":"string","description":"Timestamp when the product was last updated","format":"date-time","additionalProperties":false,"nullable":true},"user_id":{"type":"integer","description":"ID of the user who owns this product","format":"int64","additionalProperties":false},"variants":{"type":"array","description":"List of variants belonging to this product. Each variant represents a specific SKU.","additionalProperties":false,"items":{"additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.VariantViewModelV5"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.VariantInternalViewModelV5"}]},"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.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.OK.OneOf.VariantViewModelV5.VariantInternalViewModelV5":{"additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.VariantViewModelV5"},{"additionalProperties":false,"$ref":"#/components/schemas/Products.VariantInternalViewModelV5"}]},"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":{"description":"Backup action to take if primary action cannot be completed","additionalProperties":false,"$ref":"#/components/schemas/Products.EnumViewModel"},"instructions":{"type":"string","description":"Special instructions for handling returned items","additionalProperties":false,"nullable":true},"primary_action":{"description":"Primary action to take when product is returned by customer (e.g., 'Restock', 'Dispose', 'Return to Sender')","additionalProperties":false,"$ref":"#/components/schemas/Products.EnumViewModel"},"return_to_sender_backup_action":{"description":"Backup action for undeliverable packages if primary action cannot be completed","additionalProperties":false,"$ref":"#/components/schemas/Products.EnumViewModel"},"return_to_sender_primary_action":{"description":"Primary action for undeliverable packages that are returned to sender","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","description":"Unique identifier for the taxonomy","format":"int32","additionalProperties":false,"nullable":true},"name":{"type":"string","description":"Name of this taxonomy category","additionalProperties":false,"nullable":true},"parent_id":{"type":"integer","description":"ID of the parent category in the taxonomy hierarchy","format":"int32","additionalProperties":false,"nullable":true},"parent_name":{"type":"string","description":"Name of the parent category in the taxonomy hierarchy","additionalProperties":false,"nullable":true},"path":{"type":"string","description":"Full hierarchical path of the taxonomy category (e.g., 'Electronics > Computers > Laptops')","additionalProperties":false,"nullable":true}}},"Products.TaxonomyViewModel":{"type":"object","additionalProperties":false,"properties":{"children":{"type":"array","description":"Child taxonomy nodes that belong to this category","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Products.ChildTaxonomyViewModel"},"nullable":true},"parent":{"description":"Parent taxonomy node in the category hierarchy","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.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,"container_type":"string","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","description":"List of variants to update. Each variant must include an ID. Only provided fields will be updated.","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,"container_type":"string","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.UpdateProductVariantRequestModelV5":{"type":"object","additionalProperties":false,"properties":{"barcodes":{"type":"array","description":"List of barcodes associated with this variant (UPC, EAN, etc.)","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Products.BarcodeRequestModel"},"nullable":true},"id":{"type":"integer","description":"Unique identifier for the variant being updated. Required for update operations.","format":"int64","additionalProperties":false}},"allOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.BaseProductVariantRequestModel"}]},"Products.VariantInternalViewModel":{"type":"object","additionalProperties":false,"properties":{"compliance":{"additionalProperties":false,"$ref":"#/components/schemas/Products.ComplianceViewModel"}},"allOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.VariantViewModel"}]},"Products.VariantInternalViewModelV5":{"type":"object","additionalProperties":false,"properties":{"compliance":{"additionalProperties":false,"$ref":"#/components/schemas/Products.ComplianceViewModel"}},"allOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Products.VariantViewModelV5"}]},"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.VariantViewModelBase":{"type":"object","additionalProperties":false,"properties":{"additional_hazmat_attributes":{"description":"Additional hazardous materials attributes for lithium batteries and dangerous goods","additionalProperties":false,"$ref":"#/components/schemas/Products.AdditionalHazmatAttributesViewModel"},"associated_bundles":{"type":"array","description":"List of bundle products that include this variant as a component","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Products.AssociatedBundlesViewModel"},"nullable":true},"bundle_definition":{"type":"array","description":"If this variant is a bundle, defines which variants and quantities make up the bundle","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Products.BundleDefinitionViewModel"},"nullable":true},"created_on":{"type":"string","description":"Timestamp when the variant was created","format":"date-time","additionalProperties":false},"customs":{"description":"Customs and international shipping information (tariff codes, country of origin, declared value)","additionalProperties":false,"$ref":"#/components/schemas/Products.CustomsViewModel"},"dimension":{"description":"Physical dimensions of the variant (length, width, height)","additionalProperties":false,"$ref":"#/components/schemas/Products.DimensionViewModel"},"fulfillment_settings":{"description":"Fulfillment-specific settings (Prop 65, dangerous goods, serial scanning, case pick)","additionalProperties":false,"$ref":"#/components/schemas/Products.FulfillmentSettingsViewModel"},"gtin":{"type":"string","description":"Global Trade Item Number - standardized product identifier","additionalProperties":false,"nullable":true},"id":{"type":"integer","description":"Unique identifier for the variant","format":"int64","additionalProperties":false},"inventory":{"description":"Current inventory information including on-hand quantity","additionalProperties":false,"$ref":"#/components/schemas/Products.InventoryViewModel"},"is_digital":{"type":"boolean","description":"Flag indicating whether this is a digital product (no physical fulfillment)","additionalProperties":false},"is_image_uploaded":{"type":"boolean","description":"Flag indicating whether a product image has been uploaded for this variant","additionalProperties":false},"lot_information":{"description":"Lot tracking settings including whether lot tracking is enabled and minimum shelf life requirements","additionalProperties":false,"$ref":"#/components/schemas/Products.LotInformationViewModel"},"merge_children":{"type":"array","description":"List of variants that have been merged into this variant","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Products.MergedChildrenViewModel"},"nullable":true},"name":{"type":"string","description":"Variant name or descriptor","additionalProperties":false,"nullable":true},"packaging_material_type":{"description":"Type of packaging material used for this variant (ID and name)","additionalProperties":false,"$ref":"#/components/schemas/Products.EnumViewModel"},"packaging_requirement":{"description":"Special packaging requirements for this variant (ID and name)","additionalProperties":false,"$ref":"#/components/schemas/Products.EnumViewModel"},"return_preferences":{"description":"Customer return handling preferences including primary and backup actions","additionalProperties":false,"$ref":"#/components/schemas/Products.ReturnPreferencesViewModel"},"reviews_pending":{"type":"array","description":"List of pending review types for this variant (e.g., compliance checks, quality reviews)","additionalProperties":false,"items":{"type":"string","additionalProperties":false},"nullable":true},"sku":{"type":"string","description":"Stock Keeping Unit - unique identifier for the variant used in inventory management","additionalProperties":false,"nullable":true},"status":{"type":"string","description":"Current status of the variant (e.g., 'Active', 'Inactive')","additionalProperties":false,"nullable":true},"upc":{"type":"string","description":"Universal Product Code - 12-digit barcode identifier","additionalProperties":false,"nullable":true},"updated_on":{"type":"string","description":"Timestamp when the variant was last updated","format":"date-time","additionalProperties":false,"nullable":true},"weight":{"description":"Weight of the variant including unit of measure","additionalProperties":false,"$ref":"#/components/schemas/Products.WeightViewModel"}}},"Products.VariantViewModelV5":{"type":"object","additionalProperties":false,"properties":{"barcodes":{"type":"array","description":"List of barcodes associated with this variant (UPC, EAN, etc.)","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Products.BarcodeViewModel"},"nullable":true},"channel_metadata":{"type":"array","description":"Platform-specific metadata for sales channels (e.g., Amazon ASIN, Shopify product IDs)","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","description":"Unit of measurement for weight (e.g., 'lb', 'oz', 'kg', 'g')","additionalProperties":false,"nullable":true},"weight":{"type":"number","description":"Weight value of the product","format":"double","additionalProperties":false}}},"Receiving.AddBoxItemToBoxModel":{"type":"object","description":"Information about an inventory item contained inside a receiving order box","additionalProperties":false,"required":["inventory_id","quantity"],"properties":{"inventory_id":{"type":"integer","description":"Unique inventory id of the items in the box","format":"int32","additionalProperties":false},"lot_date":{"type":"string","description":"Lot expiration date for the items in the box","format":"date-time","additionalProperties":false,"nullable":true},"lot_number":{"type":"string","description":"Lot number of the items in the box","example":"2222","additionalProperties":false,"nullable":true},"quantity":{"type":"integer","description":"Quantity of the items in the box","format":"int32","maximum":2147483647.0,"minimum":1.0,"additionalProperties":false}}},"Receiving.AddBoxToOrderModel":{"type":"object","description":"Information about a box shipment to be added to a receiving order","additionalProperties":false,"required":["box_items","tracking_number"],"properties":{"box_items":{"type":"array","description":"Items contained in this box","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Receiving.AddBoxItemToBoxModel"},"nullable":true},"tracking_number":{"type":"string","description":"Tracking number for the box shipment","example":"860C8CDC8F0B4FC7AB69AC86C20539EC","additionalProperties":false,"nullable":true}}},"Receiving.AssignOrderToFulfillmentCenterModel":{"type":"object","description":"Model containing information that assigns a receiving order to a fulfillment center.\r\nIf the fulfillment center provided is in a receiving hub region, then the response will be the receiving hub location.","additionalProperties":false,"required":["id"],"properties":{"id":{"type":"integer","description":"ID of the fulfillment center to assign this receiving order to","format":"int32","additionalProperties":false}}},"Receiving.BoxItemViewModel":{"type":"object","description":"Information about an item contained inside a box as part of a receiving order","additionalProperties":false,"properties":{"inventory_id":{"type":"integer","description":"Unique identifier of the inventory item","format":"int32","additionalProperties":false},"lot_date":{"type":"string","description":"Expiration date of the item's lot","format":"date-time","additionalProperties":false,"nullable":true},"lot_number":{"type":"string","description":"Lot number the item belongs to","additionalProperties":false,"nullable":true},"quantity":{"type":"integer","description":"Quantity of the item included","format":"int32","additionalProperties":false},"received_quantity":{"type":"integer","description":"Quantity of the item that was received after processing the receiving order","format":"int32","additionalProperties":false},"stowed_quantity":{"type":"integer","description":"Quantity of the item that has been stowed","format":"int32","additionalProperties":false}}},"Receiving.BoxStatus":{"type":"string","additionalProperties":false,"enum":["Awaiting","Arrived","Completed","Counting","Stowing","Cancelled","InternalTransfer"]},"Receiving.BoxViewModel":{"type":"object","description":"Information about a box shipment included in a receiving order","additionalProperties":false,"properties":{"arrived_date":{"type":"string","description":"Date the box arrived","format":"date-time","additionalProperties":false,"nullable":true},"box_id":{"type":"integer","format":"int32","additionalProperties":false},"box_items":{"type":"array","description":"Information about the items included in the box","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Receiving.BoxItemViewModel"},"nullable":true},"box_number":{"type":"integer","description":"The number of the box in the receiving order","format":"int32","additionalProperties":false},"box_status":{"additionalProperties":false,"$ref":"#/components/schemas/Receiving.BoxStatus"},"counting_started_date":{"type":"string","description":"Date counting of the box's inventory items started","format":"date-time","additionalProperties":false,"nullable":true},"received_date":{"type":"string","description":"Date the box was received","format":"date-time","additionalProperties":false,"nullable":true},"tracking_number":{"type":"string","description":"Tracking number of the box shipment","example":"860C8CDC8F0B4FC7AB69AC86C20539EC","additionalProperties":false,"nullable":true}}},"Receiving.BoxViewModelArray":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Receiving.BoxViewModel"}},"Receiving.CreateReceivingOrderModel":{"type":"object","description":"Information to create a new receiving order","example":{"box_packaging_type":"EverythingInOneBox","boxes":[{"box_items":[{"inventory_id":0,"lot_date":"2019-08-24T14:15:22Z","lot_number":"2222","quantity":1}],"tracking_number":"860C8CDC8F0B4FC7AB69AC86C20539EC"}],"expected_arrival_date":"2019-08-24T14:15:22Z","fulfillment_center":{"id":0},"package_type":"Package","purchase_order_number":"string"},"additionalProperties":false,"required":["box_packaging_type","boxes","expected_arrival_date","fulfillment_center","package_type"],"properties":{"box_packaging_type":{"additionalProperties":false,"$ref":"#/components/schemas/Receiving.PackingType"},"boxes":{"type":"array","description":"Box shipments to be added to this receiving order","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Receiving.AddBoxToOrderModel"},"nullable":true},"expected_arrival_date":{"type":"string","description":"Expected arrival date of all the box shipments in this receiving order","format":"date-time","additionalProperties":false},"fulfillment_center":{"additionalProperties":false,"$ref":"#/components/schemas/Receiving.AssignOrderToFulfillmentCenterModel"},"package_type":{"additionalProperties":false,"$ref":"#/components/schemas/Receiving.PackageType"},"purchase_order_number":{"type":"string","description":"Purchase order number for this receiving order","additionalProperties":false,"nullable":true}}},"Receiving.DistributionItem":{"type":"object","additionalProperties":false,"properties":{"expected_quantity":{"type":"integer","description":"Quantity to be distributed according with the transfer plan calculation","format":"int32","additionalProperties":false},"fulfillment_center_abbreviation":{"type":"string","description":"Abbreviation of Destination Fulfillment Center Id, including Airport Code and Sequence Number","additionalProperties":false,"nullable":true},"fulfillment_center_id":{"type":"integer","description":"Destination Fulfillment Center Id for the item","format":"int32","additionalProperties":false},"inventory_id":{"type":"integer","description":"Inventory Id of the Item","format":"int32","additionalProperties":false},"lot_date":{"type":"string","description":"Lot expiration date of the item","format":"date-time","additionalProperties":false,"nullable":true},"lot_number":{"type":"string","description":"Lot number of the item","additionalProperties":false,"nullable":true},"product_sku":{"type":"string","description":"Product SKU","additionalProperties":false,"nullable":true},"received_quantity":{"type":"integer","description":"Quantity received at hub for this item","format":"int32","additionalProperties":false},"status":{"additionalProperties":false,"$ref":"#/components/schemas/Receiving.DistributionStatus"},"stowed_quantity":{"type":"integer","description":"Quantity stowed at Destination Fulfillment Center for this item","format":"int32","additionalProperties":false}}},"Receiving.DistributionStatus":{"type":"string","additionalProperties":false,"enum":["NotStarted","InProgress","Stowing","Completed"]},"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.FulfillmentCenterViewModelArray":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Receiving.FulfillmentCenterViewModel"}},"Receiving.Get.2.0.Receiving.CompletedEndDate.String":{"type":"string","format":"date-time","additionalProperties":false},"Receiving.Get.2.0.Receiving.CompletedStartDate.String":{"type":"string","format":"date-time","additionalProperties":false},"Receiving.Get.2.0.Receiving.ExternalSync.Boolean":{"type":"boolean","additionalProperties":false},"Receiving.Get.2.0.Receiving.FulfillmentCenterIds.IntegerArray":{"type":"array","additionalProperties":false,"items":{"type":"integer","format":"int32","additionalProperties":false}},"Receiving.Get.2.0.Receiving.IDs.IntegerArray":{"type":"array","additionalProperties":false,"items":{"type":"integer","format":"int32","additionalProperties":false}},"Receiving.Get.2.0.Receiving.Id.Boxes.Id.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Receiving.Get.2.0.Receiving.Id.Boxes.Not.Found.OneOf.ValidationProblemDetails":{"additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Receiving.ValidationProblemDetails"}]},"Receiving.Get.2.0.Receiving.Id.Id.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Receiving.Get.2.0.Receiving.Id.Labels.Bad.Request.OneOf.ValidationProblemDetails":{"additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Receiving.ValidationProblemDetails"}]},"Receiving.Get.2.0.Receiving.Id.Labels.Id.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Receiving.Get.2.0.Receiving.Id.Labels.Not.Found.OneOf.ValidationProblemDetails":{"additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Receiving.ValidationProblemDetails"}]},"Receiving.Get.2.0.Receiving.Id.Labels.OK.String":{"type":"string","format":"byte","additionalProperties":false},"Receiving.Get.2.0.Receiving.Id.Not.Found.OneOf.ValidationProblemDetails":{"additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Receiving.ValidationProblemDetails"}]},"Receiving.Get.2.0.Receiving.InsertEndDate.String":{"type":"string","format":"date-time","additionalProperties":false},"Receiving.Get.2.0.Receiving.InsertStartDate.String":{"type":"string","format":"date-time","additionalProperties":false},"Receiving.Get.2.0.Receiving.Limit.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Receiving.Get.2.0.Receiving.Not.Found.OneOf.ValidationProblemDetails":{"additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Receiving.ValidationProblemDetails"}]},"Receiving.Get.2.0.Receiving.OK.Next.Page.String":{"type":"string","additionalProperties":false},"Receiving.Get.2.0.Receiving.OK.Page.Number.Int":{"type":"integer","additionalProperties":false},"Receiving.Get.2.0.Receiving.OK.Page.Size.Int":{"type":"integer","additionalProperties":false},"Receiving.Get.2.0.Receiving.OK.Total.Count.Int":{"type":"integer","additionalProperties":false},"Receiving.Get.2.0.Receiving.OK.Total.Pages.Int":{"type":"integer","additionalProperties":false},"Receiving.Get.2.0.Receiving.Page.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Receiving.Get.2.0.Receiving.PurchaseOrderNumbers.StringArray":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}},"Receiving.Get.Receiving.Id.Distributions.Id.Integer":{"type":"integer","description":"Id of the receiving order","format":"int32","additionalProperties":false},"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.Bad.Request.Object":{"type":"object","additionalProperties":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},"Receiving.Post.2.0.Receiving.Id.Cancel.Id.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Receiving.Post.2.0.Receiving.Id.Cancel.Not.Found.OneOf.ValidationProblemDetails":{"additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Receiving.ValidationProblemDetails"}]},"Receiving.Post.2.0.Receiving.Id.Cancel.Unprocessable.Entity.Object":{"type":"object","additionalProperties":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}}},"Receiving.Post.2.0.Receiving.Not.Found.OneOf.ValidationProblemDetails":{"additionalProperties":false,"oneOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Receiving.ValidationProblemDetails"}]},"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}},"Receiving.ReceivingStatus":{"type":"string","additionalProperties":false,"enum":["Awaiting","Processing","Completed","Cancelled","Incomplete","Arrived","PartiallyArrived","PartiallyArrivedAtHub","ArrivedAtHub","ProcessingAtHub","InternalTransfer"]},"Receiving.ReceivingStatusArray":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Receiving.ReceivingStatus"}},"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.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.ReceivingOrderStatusHistoryViewModel":{"type":"object","description":"View model for receiving order status history","additionalProperties":false,"properties":{"id":{"type":"integer","description":"Unique id of the status","format":"int32","additionalProperties":false},"status":{"type":"string","description":"Name of the status","example":"Processing","additionalProperties":false,"nullable":true},"timestamp":{"type":"string","description":"Timestamp when the status was recorded","format":"date-time","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"},"status_history":{"type":"array","description":"The history of status changes for this receiving order","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Receiving.V2.ReceivingOrderStatusHistoryViewModel"},"nullable":true}}},"Receiving.V2.WarehouseReceivingOrderViewModelArray":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Receiving.V2.WarehouseReceivingOrderViewModel"}},"Receiving.ValidationProblemDetails":{"type":"object","additionalProperties":{"type":"object","additionalProperties":false},"properties":{"detail":{"type":"string","additionalProperties":false,"nullable":true},"errors":{"type":"object","readOnly":true,"additionalProperties":{"type":"array","additionalProperties":false,"items":{"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.WarehousePickupRequestStatus":{"type":"string","additionalProperties":false,"enum":["Awaiting","Processing","Completed","Cancelled","Incomplete","Arrived","PartiallyArrived","PartiallyArrivedAtHub","ArrivedAtHub","ProcessingAtHub","InternalTransfer"]},"Receiving.WroDistributionDetailsResponse":{"type":"object","additionalProperties":false,"properties":{"distributions":{"type":"array","description":"List of distribution items, for a combination of InventoryId, Lot Number, Lot Date and Destination Fulfillment Center Id","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Receiving.DistributionItem"},"nullable":true},"id":{"type":"integer","description":"Id of the receiving order","format":"int32","additionalProperties":false},"status":{"additionalProperties":false,"$ref":"#/components/schemas/Receiving.WarehousePickupRequestStatus"}}},"Returns.ActionRequestedDto":{"type":"object","description":"The details of the action requested for inventory","additionalProperties":false,"properties":{"action":{"type":"string","description":"The action to take","additionalProperties":false,"nullable":true},"action_type":{"type":"string","description":"The source of the action to take, i.e. Inventory Default or Overriden by Merchant at creation","additionalProperties":false,"nullable":true},"instructions":{"type":"string","description":"The instructions for how to take the action given by inventory owning Merchant","additionalProperties":false,"nullable":true}}},"Returns.ActionTakenDto":{"type":"object","description":"The details of an action taken for inventory item in the return","additionalProperties":false,"properties":{"action":{"type":"string","description":"The return action taken","additionalProperties":false,"nullable":true},"action_reason":{"type":"string","description":"The reason the action was taken","additionalProperties":false,"nullable":true},"image_url":{"type":"string","description":"Image of inventory processed with this action.","format":"uri","additionalProperties":false,"nullable":true},"quantity_processed":{"type":"integer","description":"The quantity of inventory items processed with this reason and action","format":"int32","additionalProperties":false}}},"Returns.ApiError":{"type":"object","additionalProperties":false,"properties":{"details":{"additionalProperties":false,"nullable":true},"errors":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false},"nullable":true},"message":{"type":"string","additionalProperties":false,"nullable":true},"stackTrace":{"type":"string","description":"StackTrace of the Exception","additionalProperties":false,"nullable":true}}},"Returns.ChannelDto":{"type":"object","description":"The details of a Channel","additionalProperties":false,"properties":{"id":{"type":"integer","description":"Unique Id of the channel","format":"int32","additionalProperties":false},"name":{"type":"string","description":"Name given to the channel","additionalProperties":false,"nullable":true}}},"Returns.CreateReturnRequest":{"type":"object","description":"The request payload for creating a Return of inventory.","example":{"fulfillment_center":{"id":0,"name":"string"},"inventory":[{"id":0,"lot_date":"2019-08-24T14:15:22Z","lot_number":"string","quantity":0,"requested_action":0}],"original_shipment_id":0,"reference_id":"string","tracking_number":"string"},"additionalProperties":false,"required":["fulfillment_center","inventory","reference_id"],"properties":{"fulfillment_center":{"additionalProperties":false,"$ref":"#/components/schemas/Returns.Facility"},"inventory":{"type":"array","description":"Array of inventory items being returned","minItems":1,"additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Returns.ReturnInventory"}},"original_shipment_id":{"type":"integer","description":"Shipment from which the items in the return originated <example>123456</example>","format":"int32","additionalProperties":false,"nullable":true},"reference_id":{"type":"string","description":"Client-defined external unique identifier for the return order.\r\n            If tracking id is not provided, this value must appear on the box label as RMA. <example>Example: ShipBob_Return_123</example>","maxLength":50,"minLength":1,"additionalProperties":false},"tracking_number":{"type":"string","description":"Tracking number for the return shipment <example>1Z9999999999999999</example>","maxLength":500,"additionalProperties":false,"nullable":true}}},"Returns.Facility":{"type":"object","description":"A Facility to process Returns.","additionalProperties":false,"required":["id"],"properties":{"id":{"type":"integer","description":"Unique identifier of the facility","format":"int32","additionalProperties":false},"name":{"type":"string","description":"Name of the facility (It is optional because public API integrations do not pass this)","additionalProperties":false,"nullable":true}}},"Returns.FulfillmentCenterDto":{"type":"object","description":"The details of a Fulfillment Center","additionalProperties":false,"properties":{"id":{"type":"integer","description":"Unique id of the fulfillment center","format":"int32","additionalProperties":false},"name":{"type":"string","description":"Name give to the fulfillment center","additionalProperties":false,"nullable":true}}},"Returns.Get.Return.CompletedEndDate.String":{"type":"string","format":"date-time","additionalProperties":false},"Returns.Get.Return.CompletedStartDate.String":{"type":"string","format":"date-time","additionalProperties":false},"Returns.Get.Return.Cursor.Integer":{"type":"integer","format":"int32","maximum":2147483647.0,"minimum":1.0,"example":1,"additionalProperties":false},"Returns.Get.Return.EndDate.String":{"type":"string","format":"date-time","additionalProperties":false},"Returns.Get.Return.FulfillmentCenterIds.String":{"type":"string","additionalProperties":false},"Returns.Get.Return.Id.Id.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Returns.Get.Return.Id.Shipbob.Channel.Id.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Returns.Get.Return.Ids.String":{"type":"string","additionalProperties":false},"Returns.Get.Return.InventoryIds.String":{"type":"string","additionalProperties":false},"Returns.Get.Return.Limit.Integer":{"type":"integer","format":"int32","example":25,"additionalProperties":false},"Returns.Get.Return.OK.Page.Number.String":{"type":"string","description":"Current page number","format":"","additionalProperties":false},"Returns.Get.Return.OK.Page.Size.String":{"type":"string","description":"Page size","format":"","additionalProperties":false},"Returns.Get.Return.OK.Total.Count.String":{"type":"string","description":"Total records","format":"","additionalProperties":false},"Returns.Get.Return.OK.Total.Pages.String":{"type":"string","description":"Total pages","format":"","additionalProperties":false},"Returns.Get.Return.OriginalShipmentIds.String":{"type":"string","additionalProperties":false},"Returns.Get.Return.ReferenceIds.String":{"type":"string","additionalProperties":false},"Returns.Get.Return.ReturnActions.String":{"type":"string","additionalProperties":false},"Returns.Get.Return.ReturnTypes.String":{"type":"string","additionalProperties":false},"Returns.Get.Return.Shipbob.Channel.Id.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Returns.Get.Return.Sortby.String":{"type":"string","additionalProperties":false},"Returns.Get.Return.StartDate.String":{"type":"string","format":"date-time","additionalProperties":false},"Returns.Get.Return.Status.String":{"type":"string","additionalProperties":false},"Returns.Get.Return.StoreOrderIds.String":{"type":"string","additionalProperties":false},"Returns.Get.Return.TrackingNumbers.String":{"type":"string","additionalProperties":false},"Returns.InventoryItemDto":{"type":"object","description":"The details of the inventory in the return order","additionalProperties":false,"properties":{"action_requested":{"additionalProperties":false,"$ref":"#/components/schemas/Returns.ActionRequestedDto"},"action_taken":{"type":"array","description":"List of actions taken","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Returns.ActionTakenDto"},"nullable":true},"barcodes":{"type":"array","description":"List of barcodes associated with the inventory item","additionalProperties":false,"items":{"type":"string","additionalProperties":false},"nullable":true},"id":{"type":"integer","description":"Unique id of the inventory","format":"int32","additionalProperties":false},"lot_information":{"additionalProperties":false,"$ref":"#/components/schemas/Returns.LotInformationDto"},"name":{"type":"string","description":"Name of the product","additionalProperties":false,"nullable":true},"quantity":{"type":"integer","description":"Number of inventory that is being returned","format":"int32","additionalProperties":false},"sku":{"type":"string","description":"Stock keeping unit identifier for the inventory item","additionalProperties":false,"nullable":true}}},"Returns.InventoryItemV1Dto":{"type":"object","description":"The details of the inventory in the return order","additionalProperties":false,"properties":{"action_requested":{"additionalProperties":false,"$ref":"#/components/schemas/Returns.ActionRequestedDto"},"action_taken":{"type":"array","description":"List of actions taken","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Returns.ActionTakenDto"},"nullable":true},"id":{"type":"integer","description":"Unique id of the inventory","format":"int32","additionalProperties":false},"name":{"type":"string","description":"Name of the product","additionalProperties":false,"nullable":true},"quantity":{"type":"integer","description":"Number of inventory that is being returned","format":"int32","additionalProperties":false}}},"Returns.InvoiceDto":{"type":"object","description":"The invoice amount and curency","additionalProperties":false,"properties":{"amount":{"type":"number","description":"Amount being charged","format":"double","additionalProperties":false,"nullable":true},"currency_code":{"type":"string","description":"Currency code of amount","additionalProperties":false,"nullable":true}}},"Returns.LotInformationDto":{"type":"object","description":"Lot information associated with a specific inventory item.","additionalProperties":false,"properties":{"expiration":{"type":"string","description":"The expiration date for this lot.","format":"date-time","additionalProperties":false,"nullable":true},"minimumShelfLife":{"type":"integer","description":"A minimum amount of time in days this product can be safely returned to the shelf without expiring.","format":"int32","additionalProperties":false,"nullable":true},"number":{"type":"string","description":"An alphanumeric string uniquely identifying this lot of produced inventory.","additionalProperties":false,"nullable":true}}},"Returns.Post.Api.Public.Cancel.Id.Api.Version.String":{"type":"string","default":"1.0","additionalProperties":false},"Returns.Post.Api.Public.Cancel.Id.Id.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Returns.Post.Return.CreationSourceId.Integer":{"type":"integer","format":"int32","default":3,"additionalProperties":false},"Returns.Post.Return.Shipbob.Channel.Id.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Returns.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}}},"Returns.PublicReturnDto":{"type":"object","description":"The details of a public return order, including the transactions and inventory items","additionalProperties":false,"properties":{"arrived_date":{"type":"string","description":"The date and time when the return arrived at the fulfillment center","format":"date-time","additionalProperties":false,"nullable":true},"awaiting_arrival_date":{"type":"string","description":"The date and time when the return entered Awaiting Arrival status","format":"date-time","additionalProperties":false,"nullable":true},"cancelled_date":{"type":"string","description":"The date and time when the return was cancelled, if applicable","format":"date-time","additionalProperties":false,"nullable":true},"channel":{"additionalProperties":false,"$ref":"#/components/schemas/Returns.ChannelDto"},"completed_date":{"type":"string","description":"The date and time for when the return order was completely processed","format":"date-time","additionalProperties":false,"nullable":true},"customer_name":{"type":"string","description":"Name of merchant that return belongs to","additionalProperties":false,"nullable":true},"fulfillment_center":{"additionalProperties":false,"$ref":"#/components/schemas/Returns.FulfillmentCenterDto"},"id":{"type":"integer","description":"Unique id of the return order","format":"int32","additionalProperties":false},"insert_date":{"type":"string","description":"The date and time for when the return order was created","format":"date-time","additionalProperties":false},"inventory":{"type":"array","description":"List of inventory items in return order","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Returns.InventoryItemDto"},"nullable":true},"invoice":{"additionalProperties":false,"$ref":"#/components/schemas/Returns.InvoiceDto"},"original_shipment_id":{"type":"integer","description":"ShipmentId for which return was created","format":"int32","additionalProperties":false,"nullable":true},"processing_date":{"type":"string","description":"The date and time when the return started processing","format":"date-time","additionalProperties":false,"nullable":true},"reference_id":{"type":"string","description":"Unique reference id of the return order. Created by merchant if a regular return.","additionalProperties":false,"nullable":true},"return_type":{"type":"string","description":"Type of the return, i.e. Regular, RTS","additionalProperties":false,"nullable":true},"shipment_tracking_number":{"type":"string","description":"The tracking number of the original shipment","additionalProperties":false,"nullable":true},"status":{"type":"string","description":"Status of the return order, i.e. `Awaiting Arrival`, `Arrived`, `Processing`, `Completed` `Cancelled`","additionalProperties":false,"nullable":true},"status_history":{"type":"array","description":"List of status history in return order","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Returns.StatusHistoryDto"},"nullable":true},"store_order_id":{"type":"string","description":"Reference to external order id","additionalProperties":false,"nullable":true},"tracking_number":{"type":"string","description":"The tracking number of the return shipping label","additionalProperties":false,"nullable":true},"transactions":{"type":"array","description":"List of transactions that make up the billable amount to invoice a merchant","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Returns.TransactionDto"},"nullable":true}}},"Returns.PublicReturnDtoPagedUrlResultDto":{"type":"object","additionalProperties":false,"properties":{"first":{"type":"string","description":"Return url for first cursor","format":"uri","additionalProperties":false,"nullable":true},"items":{"type":"array","description":"Return records","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Returns.PublicReturnDto"},"nullable":true},"last":{"type":"string","description":"Return url for last cursor","format":"uri","additionalProperties":false,"nullable":true},"next":{"type":"string","description":"Return url for next cursor","format":"uri","additionalProperties":false,"nullable":true},"prev":{"type":"string","description":"Return url for prev cursor","format":"uri","additionalProperties":false,"nullable":true}}},"Returns.PublicReturnV1Dto":{"type":"object","description":"The details of a public return order (V1), including the transactions and inventory items","additionalProperties":false,"properties":{"channel":{"additionalProperties":false,"$ref":"#/components/schemas/Returns.ChannelDto"},"completed_date":{"type":"string","description":"The date and time for when the return order was completely processed","format":"date-time","additionalProperties":false,"nullable":true},"customer_name":{"type":"string","description":"Name of merchant that return belongs to","additionalProperties":false,"nullable":true},"fulfillment_center":{"additionalProperties":false,"$ref":"#/components/schemas/Returns.FulfillmentCenterDto"},"id":{"type":"integer","description":"Unique id of the return order","format":"int32","additionalProperties":false},"insert_date":{"type":"string","description":"The date and time for when the return order was created","format":"date-time","additionalProperties":false},"inventory":{"type":"array","description":"List of inventory items in return order","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Returns.InventoryItemV1Dto"},"nullable":true},"invoice_amount":{"type":"number","description":"Amount merchant was invoiced for processing the return","format":"double","additionalProperties":false,"nullable":true},"original_shipment_id":{"type":"integer","description":"ShipmentId for which return was created","format":"int32","additionalProperties":false,"nullable":true},"reference_id":{"type":"string","description":"Unique reference id of the return order. Created by merchant if a regular return.","additionalProperties":false,"nullable":true},"return_type":{"type":"string","description":"Type of the return, i.e. Regular, RTS","additionalProperties":false,"nullable":true},"status":{"type":"string","description":"Status of the return order, i.e. `Awaiting Arrival`, `Arrived`, `Processing`, `Completed` `Cancelled`","additionalProperties":false,"nullable":true},"store_order_id":{"type":"string","description":"Reference to external order id","additionalProperties":false,"nullable":true},"tracking_number":{"type":"string","description":"The tracking number of the return shipping label","additionalProperties":false,"nullable":true},"transactions":{"type":"array","description":"List of transactions that make up the billable amount to invoice a merchant","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Returns.TransactionDto"},"nullable":true}}},"Returns.Put.Api.Public.Id.Api.Version.String":{"type":"string","default":"1.0","additionalProperties":false},"Returns.Put.Api.Public.Id.Id.Integer":{"type":"integer","format":"int32","additionalProperties":false},"Returns.ReturnAction":{"type":"string","format":"int32","additionalProperties":false,"enum":["Default","Restock","Quarantine","Dispose"]},"Returns.ReturnInventory":{"type":"object","description":"An inventory being returned, includes the quantity and an override for the return action.","additionalProperties":false,"required":["id","quantity","requested_action"],"properties":{"id":{"type":"integer","description":"ID of the inventory item to return.","format":"int32","additionalProperties":false},"lot_date":{"type":"string","description":"Lot date associated with the inventory item, if applicable.","format":"date-time","additionalProperties":false,"nullable":true},"lot_number":{"type":"string","description":"Lot number associated with the inventory item, if applicable.","additionalProperties":false,"nullable":true},"quantity":{"type":"integer","description":"Quantity of the returned inventory item in the return.","format":"int32","additionalProperties":false},"requested_action":{"additionalProperties":false,"$ref":"#/components/schemas/Returns.ReturnAction"}}},"Returns.SortOrder":{"type":"string","format":"int32","additionalProperties":false,"enum":["Desc","Asc"]},"Returns.StatusHistoryDto":{"type":"object","description":"Status history","additionalProperties":false,"properties":{"status":{"type":"string","description":"Status to change","additionalProperties":false,"nullable":true},"timestamp":{"type":"string","description":"Date change status","format":"date-time","additionalProperties":false}}},"Returns.TransactionDto":{"type":"object","description":"The details of a transaction charged to the return order","additionalProperties":false,"properties":{"amount":{"type":"number","description":"The amount charged for this transaction","format":"double","additionalProperties":false},"transaction_type":{"type":"string","description":"The type of transaction","additionalProperties":false,"nullable":true}}},"Tracking.Get.Api.V1.Publictracking.Shipments.Bad.Request.String":{"type":"string","additionalProperties":false},"Tracking.Get.Api.V1.Publictracking.Shipments.Internal.Server.Error.String":{"type":"string","additionalProperties":false},"Tracking.Get.Api.V1.Publictracking.Shipments.ShipmentIds.IntegerArray":{"type":"array","description":"A list of ShipBob shipment IDs. Must contain between 1 and 25 IDs per request.","additionalProperties":false,"items":{"type":"integer","format":"int64","additionalProperties":false}},"Tracking.Get.Api.V1.Publictracking.Tracking.Ids.Bad.Request.String":{"type":"string","additionalProperties":false},"Tracking.Get.Api.V1.Publictracking.Tracking.Ids.Internal.Server.Error.String":{"type":"string","additionalProperties":false},"Tracking.Get.Api.V1.Publictracking.Tracking.Ids.TrackingIds.StringArray":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false}},"Tracking.PlatformShipmentTrackingResponse":{"type":"object","additionalProperties":false,"properties":{"carrier":{"type":"string","description":"The name of the carrier handling the shipment (e.g., UPS, FedEx, USPS)","additionalProperties":false,"nullable":true},"carrier_message":{"type":"string","description":"The raw status message provided by the carrier","additionalProperties":false,"nullable":true},"carrier_tracking_number":{"type":"string","description":"The tracking number assigned by the carrier","additionalProperties":false,"nullable":true},"eta":{"type":"string","description":"The estimated date and time of delivery","format":"date-time","additionalProperties":false,"nullable":true},"history":{"type":"array","description":"A list of historical tracking events for the shipment","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Tracking.TrackingHistoryItem"},"nullable":true},"last_updated":{"type":"string","description":"The date and time when the tracking information was last updated","format":"date-time","additionalProperties":false},"location":{"type":"string","description":"The current geographic location of the shipment","additionalProperties":false,"nullable":true},"message":{"type":"string","description":"A human-readable message describing the current shipment status","additionalProperties":false,"nullable":true},"public_tracking_url":{"type":"string","description":"A publicly accessible URL for tracking the shipment on the carrier's website","additionalProperties":false,"nullable":true},"service":{"type":"string","description":"The carrier service level used for the shipment (e.g., Ground, Express)","additionalProperties":false,"nullable":true},"status":{"type":"string","description":"The current high-level status of the shipment","additionalProperties":false,"enum":["Available for Pickup","Cancelled","Delivered","Delivery attempt Failed","DeliveryException","Exception","Failed","InTransit","PreTransit","Return to sender"],"nullable":true},"substatus":{"type":"string","description":"A more granular status code describing the current state of the shipment. Possible values include: 'Delivered', 'Failed Attempt', 'In Transit', 'Delayed', 'Label created', etc.","additionalProperties":false,"nullable":true},"tracking_id":{"type":"string","description":"The unique tracking identifier assigned to the shipment","additionalProperties":false,"nullable":true}}},"Tracking.PlatformShipmentTrackingResponseArray":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Tracking.PlatformShipmentTrackingResponse"}},"Tracking.ShipmentTrackingResponse":{"type":"object","additionalProperties":false,"properties":{"carrier":{"type":"string","description":"The name of the carrier handling the shipment (e.g., UPS, FedEx, USPS)","additionalProperties":false,"nullable":true},"carrier_message":{"type":"string","description":"The raw status message provided by the carrier","additionalProperties":false,"nullable":true},"carrier_tracking_number":{"type":"string","description":"The tracking number assigned by the carrier","additionalProperties":false,"nullable":true},"eta":{"type":"string","description":"The estimated date and time of delivery","format":"date-time","additionalProperties":false,"nullable":true},"history":{"type":"array","description":"A list of historical tracking events for the shipment","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Tracking.TrackingHistoryItem"},"nullable":true},"last_updated":{"type":"string","description":"The date and time when the tracking information was last updated","format":"date-time","additionalProperties":false},"location":{"type":"string","description":"The current geographic location of the shipment","additionalProperties":false,"nullable":true},"message":{"type":"string","description":"A human-readable message describing the current shipment status","additionalProperties":false,"nullable":true},"public_tracking_url":{"type":"string","description":"A publicly accessible URL for tracking the shipment on the carrier's website","additionalProperties":false,"nullable":true},"service":{"type":"string","description":"The carrier service level used for the shipment (e.g., Ground, Express)","additionalProperties":false,"nullable":true},"shipment_id":{"type":"integer","description":"The unique identifier of the shipment in ShipBob's system","format":"int64","additionalProperties":false},"status":{"type":"string","description":"The current high-level status of the shipment","additionalProperties":false,"enum":["Available for Pickup","Cancelled","Delivered","Delivery attempt Failed","DeliveryException","Exception","Failed","InTransit","PreTransit","Return to sender"],"nullable":true},"substatus":{"type":"string","description":"A more granular status code describing the current state of the shipment. Possible values include: 'Delivered', 'Failed Attempt', 'In Transit', 'Delayed', 'Label created', etc.","additionalProperties":false,"nullable":true},"tracking_id":{"type":"string","description":"The unique tracking identifier assigned to the shipment","additionalProperties":false,"nullable":true}}},"Tracking.ShipmentTrackingResponseArray":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Tracking.ShipmentTrackingResponse"}},"Tracking.TrackingHistoryItem":{"type":"object","additionalProperties":false,"properties":{"carrier_message":{"type":"string","description":"The raw message provided by the carrier for this tracking event","additionalProperties":false,"nullable":true},"location":{"type":"string","description":"The geographic location where this tracking event occurred","additionalProperties":false,"nullable":true},"message":{"type":"string","description":"A human-readable message describing this tracking event","additionalProperties":false,"nullable":true},"status":{"type":"string","description":"The high-level status at the time of this tracking event","additionalProperties":false,"enum":["Available for Pickup","Cancelled","Delivered","Delivery attempt Failed","DeliveryException","Exception","Failed","InTransit","PreTransit","Return to sender"],"nullable":true},"substatus":{"type":"string","description":"A more granular status code at the time of this tracking event. Possible values include: 'Delivered', 'Failed Attempt', 'In Transit', 'Delayed', 'Label created', etc.","additionalProperties":false,"nullable":true},"timestamp":{"type":"string","description":"The date and time when this tracking event occurred","format":"date-time","additionalProperties":false}}},"Webhooks.ActionResult":{"type":"object","discriminator":{"propertyName":"$type"},"additionalProperties":false,"required":["$type"],"properties":{"$type":{"type":"string","additionalProperties":false}}},"Webhooks.BadRequestObjectResult":{"additionalProperties":false,"allOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Webhooks.ObjectResult"},{"type":"object","additionalProperties":false,"properties":{"content_types":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false},"nullable":true},"declared_type":{"additionalProperties":false,"oneOf":[{"type":"string","additionalProperties":false},{"additionalProperties":false,"oneOf":[{"type":"string","additionalProperties":false},{"type":"string","additionalProperties":false},{"type":"string","additionalProperties":false}]},{"type":"string","additionalProperties":false},{"type":"string","additionalProperties":false},{"type":"string","additionalProperties":false},{"type":"string","additionalProperties":false},{"type":"string","additionalProperties":false},{"type":"string","additionalProperties":false},{"type":"string","additionalProperties":false},{"additionalProperties":false,"oneOf":[{"type":"string","additionalProperties":false}]},{"additionalProperties":false,"oneOf":[{"type":"string","additionalProperties":false},{"type":"string","additionalProperties":false},{"type":"string","additionalProperties":false}]},{"type":"string","additionalProperties":false},{"additionalProperties":false,"oneOf":[{"type":"string","additionalProperties":false},{"type":"string","additionalProperties":false},{"type":"string","additionalProperties":false},{"type":"string","additionalProperties":false},{"additionalProperties":false,"oneOf":[{"type":"string","additionalProperties":false}]},{"additionalProperties":false,"oneOf":[{"type":"string","additionalProperties":false},{"type":"string","additionalProperties":false},{"type":"string","additionalProperties":false}]},{"type":"string","additionalProperties":false}]},{"type":"string","additionalProperties":false},{"additionalProperties":false,"oneOf":[{"type":"string","additionalProperties":false},{"type":"string","additionalProperties":false},{"type":"string","additionalProperties":false},{"type":"string","additionalProperties":false},{"additionalProperties":false,"oneOf":[{"type":"string","additionalProperties":false}]},{"type":"string","additionalProperties":false},{"additionalProperties":false,"oneOf":[{"type":"string","additionalProperties":false}]},{"additionalProperties":false,"oneOf":[{"type":"string","additionalProperties":false}]},{"type":"string","additionalProperties":false},{"type":"string","additionalProperties":false}]},{"type":"string","additionalProperties":false},{"type":"string","additionalProperties":false},{"additionalProperties":false,"oneOf":[{"type":"string","additionalProperties":false}]},{"type":"string","additionalProperties":false},{"additionalProperties":false,"oneOf":[{"type":"string","additionalProperties":false}]},{"additionalProperties":false,"oneOf":[{"type":"string","additionalProperties":false}]},{"type":"string","additionalProperties":false},{"type":"string","additionalProperties":false}],"nullable":true},"formatters":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Webhooks.IOutputFormatter"},"nullable":true},"status_code":{"type":"integer","format":"int32","additionalProperties":false,"nullable":true},"value":{"type":"object","additionalProperties":false,"nullable":true}}}]},"Webhooks.Delete.V2.Webhook.Id.Id.String":{"type":"string","description":"This is the id of the webhook subscription to delete","additionalProperties":false,"nullable":true},"Webhooks.Get.V2.Webhook.Cursor.String":{"type":"string","description":"[Optional] A pagination token used to retrieve the next or previous page of results. Omit to start at the first page.","additionalProperties":false,"nullable":true},"Webhooks.Get.V2.Webhook.RecordsPerPage.Integer":{"type":"integer","description":"Number of webhooks returned per page in a paginated response.","format":"int32","maximum":250.0,"minimum":1.0,"additionalProperties":false},"Webhooks.GetWebhookResponse":{"type":"object","additionalProperties":false,"properties":{"items":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Webhooks.V2.WebhookViewModelV2"},"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}}},"Webhooks.IOutputFormatter":{"type":"object","additionalProperties":false},"Webhooks.ObjectResult":{"additionalProperties":false,"allOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Webhooks.ActionResult"},{"type":"object","discriminator":{"propertyName":"$type"},"additionalProperties":false,"required":["$type"],"properties":{"content_types":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false},"nullable":true},"declared_type":{"additionalProperties":false,"oneOf":[{"type":"string","additionalProperties":false},{"additionalProperties":false,"oneOf":[{"type":"string","additionalProperties":false},{"type":"string","additionalProperties":false},{"type":"string","additionalProperties":false}]},{"type":"string","additionalProperties":false},{"type":"string","additionalProperties":false},{"type":"string","additionalProperties":false},{"type":"string","additionalProperties":false},{"type":"string","additionalProperties":false},{"type":"string","additionalProperties":false},{"type":"string","additionalProperties":false},{"additionalProperties":false,"oneOf":[{"type":"string","additionalProperties":false}]},{"additionalProperties":false,"oneOf":[{"type":"string","additionalProperties":false},{"type":"string","additionalProperties":false},{"type":"string","additionalProperties":false}]},{"type":"string","additionalProperties":false},{"additionalProperties":false,"oneOf":[{"type":"string","additionalProperties":false},{"type":"string","additionalProperties":false},{"type":"string","additionalProperties":false},{"type":"string","additionalProperties":false},{"additionalProperties":false,"oneOf":[{"type":"string","additionalProperties":false}]},{"additionalProperties":false,"oneOf":[{"type":"string","additionalProperties":false},{"type":"string","additionalProperties":false},{"type":"string","additionalProperties":false}]},{"type":"string","additionalProperties":false}]},{"type":"string","additionalProperties":false},{"additionalProperties":false,"oneOf":[{"type":"string","additionalProperties":false},{"type":"string","additionalProperties":false},{"type":"string","additionalProperties":false},{"type":"string","additionalProperties":false},{"additionalProperties":false,"oneOf":[{"type":"string","additionalProperties":false}]},{"type":"string","additionalProperties":false},{"additionalProperties":false,"oneOf":[{"type":"string","additionalProperties":false}]},{"additionalProperties":false,"oneOf":[{"type":"string","additionalProperties":false}]},{"type":"string","additionalProperties":false},{"type":"string","additionalProperties":false}]},{"type":"string","additionalProperties":false},{"type":"string","additionalProperties":false},{"additionalProperties":false,"oneOf":[{"type":"string","additionalProperties":false}]},{"type":"string","additionalProperties":false},{"additionalProperties":false,"oneOf":[{"type":"string","additionalProperties":false}]},{"additionalProperties":false,"oneOf":[{"type":"string","additionalProperties":false}]},{"type":"string","additionalProperties":false},{"type":"string","additionalProperties":false}],"nullable":true},"formatters":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Webhooks.IOutputFormatter"},"nullable":true},"status_code":{"type":"integer","format":"int32","additionalProperties":false,"nullable":true},"value":{"type":"object","additionalProperties":false,"nullable":true}}}]},"Webhooks.Topics":{"type":"string","example":"order.shipped","additionalProperties":false,"enum":["order.shipped","order.shipment.delivered","order.shipment.exception","order.shipment.on_hold","order.shipment.cancelled","return.created","return.updated","return.completed"]},"Webhooks.UnprocessableEntityObjectResult":{"additionalProperties":false,"allOf":[{"additionalProperties":false,"$ref":"#/components/schemas/Webhooks.ObjectResult"},{"type":"object","additionalProperties":false,"properties":{"content_types":{"type":"array","additionalProperties":false,"items":{"type":"string","additionalProperties":false},"nullable":true},"declared_type":{"additionalProperties":false,"oneOf":[{"type":"string","additionalProperties":false},{"additionalProperties":false,"oneOf":[{"type":"string","additionalProperties":false},{"type":"string","additionalProperties":false},{"type":"string","additionalProperties":false}]},{"type":"string","additionalProperties":false},{"type":"string","additionalProperties":false},{"type":"string","additionalProperties":false},{"type":"string","additionalProperties":false},{"type":"string","additionalProperties":false},{"type":"string","additionalProperties":false},{"type":"string","additionalProperties":false},{"additionalProperties":false,"oneOf":[{"type":"string","additionalProperties":false}]},{"additionalProperties":false,"oneOf":[{"type":"string","additionalProperties":false},{"type":"string","additionalProperties":false},{"type":"string","additionalProperties":false}]},{"type":"string","additionalProperties":false},{"additionalProperties":false,"oneOf":[{"type":"string","additionalProperties":false},{"type":"string","additionalProperties":false},{"type":"string","additionalProperties":false},{"type":"string","additionalProperties":false},{"additionalProperties":false,"oneOf":[{"type":"string","additionalProperties":false}]},{"additionalProperties":false,"oneOf":[{"type":"string","additionalProperties":false},{"type":"string","additionalProperties":false},{"type":"string","additionalProperties":false}]},{"type":"string","additionalProperties":false}]},{"type":"string","additionalProperties":false},{"additionalProperties":false,"oneOf":[{"type":"string","additionalProperties":false},{"type":"string","additionalProperties":false},{"type":"string","additionalProperties":false},{"type":"string","additionalProperties":false},{"additionalProperties":false,"oneOf":[{"type":"string","additionalProperties":false}]},{"type":"string","additionalProperties":false},{"additionalProperties":false,"oneOf":[{"type":"string","additionalProperties":false}]},{"additionalProperties":false,"oneOf":[{"type":"string","additionalProperties":false}]},{"type":"string","additionalProperties":false},{"type":"string","additionalProperties":false}]},{"type":"string","additionalProperties":false},{"type":"string","additionalProperties":false},{"additionalProperties":false,"oneOf":[{"type":"string","additionalProperties":false}]},{"type":"string","additionalProperties":false},{"additionalProperties":false,"oneOf":[{"type":"string","additionalProperties":false}]},{"additionalProperties":false,"oneOf":[{"type":"string","additionalProperties":false}]},{"type":"string","additionalProperties":false},{"type":"string","additionalProperties":false}],"nullable":true},"formatters":{"type":"array","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Webhooks.IOutputFormatter"},"nullable":true},"status_code":{"type":"integer","format":"int32","additionalProperties":false,"nullable":true},"value":{"type":"object","additionalProperties":false,"nullable":true}}}]},"Webhooks.V2.Create.WebhookViewModelV2":{"type":"object","additionalProperties":false,"properties":{"created_at":{"type":"string","description":"TimeStamp the webhook subscription was created","format":"date-time","additionalProperties":false},"description":{"type":"string","description":"Description of the webhook subscription","additionalProperties":false,"nullable":true},"id":{"type":"string","description":"ID of the webhook subscription","example":"12345","additionalProperties":false},"secret":{"type":"string","description":"A secret key used to sign the webhook payload for verifying its authenticity on the receiver's end.","pattern":"^whsec_[a-zA-Z0-9+/]{32}$","additionalProperties":false},"topics":{"type":"array","description":"List of event types the webhook will receive notifications for","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Webhooks.Topics"}},"url":{"type":"string","description":"URL subscription events will be posted to","additionalProperties":false}}},"Webhooks.V2.CreateSubscriptionRequest":{"type":"object","example":{"description":"string","secret":"string","topics":["string"],"url":"https://mywebsite.com/shipbob/handler"},"additionalProperties":false,"required":["topics","url"],"properties":{"description":{"type":"string","description":"Description of the webhook subscription.","additionalProperties":false,"nullable":true},"secret":{"type":"string","description":"A secret key used to sign the webhook payload for verifying its authenticity on the receiver's end.","pattern":"^whsec_[a-zA-Z0-9+/]{32}$","additionalProperties":false,"nullable":true},"topics":{"type":"array","description":"The event types for which webhook callbacks will be received.","minLength":1,"additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Webhooks.Topics"}},"url":{"type":"string","description":"The URL that will be called when an event matching the subscription topic occurs.\r\nThe URL must use HTTPS, accept POST requests, and handle content of type application/json.","format":"uri","example":"https://mywebsite.com/shipbob/handler","additionalProperties":false}}},"Webhooks.V2.WebhookViewModelV2":{"type":"object","additionalProperties":false,"properties":{"created_at":{"type":"string","description":"TimeStamp the webhook subscription was created","format":"date-time","additionalProperties":false},"description":{"type":"string","description":"Description of the webhook subscription","additionalProperties":false,"nullable":true},"enabled":{"type":"boolean","description":"Indicates if the webhook subscription is enabled or not","additionalProperties":false},"id":{"type":"string","description":"ID of the webhook subscription","example":"12345","additionalProperties":false},"topics":{"type":"array","description":"List of event types the webhook will receive notifications for","additionalProperties":false,"items":{"additionalProperties":false,"$ref":"#/components/schemas/Webhooks.Topics"}},"url":{"type":"string","description":"URL subscription events will be posted to","additionalProperties":false}}}},"securitySchemes":{"PAT":{"type":"http","scheme":"bearer","bearerFormat":"PAT","description":"Authentication using Personal Access Token (PAT) token"},"OAuth2":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://auth.shipbob.com/connect/authorize","tokenUrl":"https://auth.shipbob.com/connect/token","scopes":{"channels_read":"Read channel metadata","channels_write":"Write channel metadata","inventory_read":"Access inventory read operations","inventory_write":"Access inventory write operations","orders_read":"Access orders read operations","orders_write":"Access orders write operations","products_read":"Access products read operations","products_write":"Access products write operations","receiving_read":"Access receiving read operations","receiving_write":"Access receiving write operations","returns_read":"Access returns read operations","returns_write":"Access returns write operations","webhooks_read":"Access webhooks read operations","webhooks_write":"Access webhooks write operations","locations_read":"Access locations read operations","tracking_read":"Access tracking read operations"}}},"description":"OAuth2 authentication using JWT tokens"}}}}