generated: '2026-08-23' method: derived source: openapi/kargo-document-intake-openapi.yml note: Named request examples published by Kargo inside its own OpenAPI document, extracted here as a standalone catalog. Every value below is verbatim from the spec at https://api.kargo.zone/v1/docs/openapi.yaml. examples: - operationId: createDocument path: /documents method: POST media_type: application/json name: orderWithFivePallets summary: Create an outbound order with five pallet items value: orderNumber: TEST-EXAMPLE-ORDER-001 business: kargo facility: sf direction: OUTBOUND shipmentNumber: TEST-EXAMPLE-SHIPMENT-001 items: - lpn: LPNABC sku: SKU123 quantity: 10 quantityUnit: CASE caseSerials: - id: 00000000000379386070 quantity: 10 - lpn: LPNABC sku: SKU456 quantity: 8 quantityUnit: CASE - lpn: LPNDEF sku: SKU789 quantity: 12 quantityUnit: CASE - lpn: LPNGHI sku: SKU123 quantity: 6 quantityUnit: CASE - lpn: LPNJKL sku: SKU999 quantity: 15 quantityUnit: CASE - operationId: createDocument path: /documents method: POST media_type: application/json name: appendOrderItem summary: Append an order item value: orderNumber: TEST-EXAMPLE-ORDER-001 business: kargo facility: sf direction: OUTBOUND shipmentNumber: TEST-EXAMPLE-SHIPMENT-001 orderItemUpdateStrategy: APPEND items: - lpn: LPNNEW sku: SKUAPPEND quantity: 1 quantityUnit: UNIT - operationId: createDocument path: /documents method: POST media_type: application/json name: mergeOrderItemByLpnAndSku summary: Update or add an order item by LPN + SKU value: orderNumber: TEST-EXAMPLE-ORDER-001 business: kargo facility: sf direction: OUTBOUND shipmentNumber: TEST-EXAMPLE-SHIPMENT-001 orderItemUpdateStrategy: MERGE items: - lpn: LPNABC sku: SKU123 quantity: 5 quantityUnit: CASE - operationId: createDocument path: /documents method: POST media_type: application/json name: deleteOrderItemByLpnAndSku summary: Delete an order item by LPN + SKU value: orderNumber: TEST-EXAMPLE-ORDER-001 business: kargo facility: sf direction: OUTBOUND shipmentNumber: TEST-EXAMPLE-SHIPMENT-001 orderItemUpdateStrategy: DELETE items: - lpn: LPNABC sku: SKU123 - operationId: createDocument path: /documents method: POST media_type: application/json name: overwriteOrderItems summary: Replace all order items value: orderNumber: TEST-EXAMPLE-ORDER-001 business: kargo facility: sf direction: OUTBOUND shipmentNumber: TEST-EXAMPLE-SHIPMENT-001 orderItemUpdateStrategy: OVERWRITE items: - lpn: LPNREPLACE001 sku: SKUREPLACE001 quantity: 2 quantityUnit: UNIT - lpn: LPNREPLACE002 sku: SKUREPLACE002 quantity: 3 quantityUnit: CASE - operationId: createDocument path: /documents method: POST media_type: application/json name: shipmentWithMultipleOrders summary: Shipment with multiple orders value: business: kargo facility: sf direction: OUTBOUND shipmentNumber: TEST-EXAMPLE-SHIPMENT-001 orders: - orderNumber: TEST-EXAMPLE-ORDER-001 items: - lpn: LPNMULTI001 sku: SKUMULTI001 quantity: 10 quantityUnit: CASE caseSerials: - id: 00000000000379386070 quantity: 10 - orderNumber: TEST-EXAMPLE-ORDER-002 items: - lpn: LPNMULTI002 sku: SKUMULTI002 quantity: 8 quantityUnit: CASE - operationId: createDocument path: /documents method: POST media_type: application/json name: shipmentWithMultipleOrdersShipmentLevelStrategy summary: Shipment with multiple orders using shipment level strategy value: business: kargo facility: sf direction: OUTBOUND shipmentNumber: TEST-EXAMPLE-SHIPMENT-001 orderItemUpdateStrategy: MERGE orders: - orderNumber: TEST-EXAMPLE-ORDER-001 items: - lpn: LPNMULTI101 sku: SKUMULTI101 quantity: 10 quantityUnit: CASE - orderNumber: TEST-EXAMPLE-ORDER-002 items: - lpn: LPNMULTI102 sku: SKUMULTI102 quantity: 8 quantityUnit: CASE - operationId: createDocument path: /documents method: POST media_type: application/json name: shipmentWithMultipleOrdersOrderLevelStrategies summary: Shipment with multiple orders using order level strategies value: business: kargo facility: sf direction: OUTBOUND shipmentNumber: TEST-EXAMPLE-SHIPMENT-001 orders: - orderNumber: TEST-EXAMPLE-ORDER-001 orderItemUpdateStrategy: APPEND items: - lpn: LPNMULTI201 sku: SKUMULTI201 quantity: 4 quantityUnit: CASE - orderNumber: TEST-EXAMPLE-ORDER-002 orderItemUpdateStrategy: DELETE items: - lpn: LPNMULTI202 sku: SKUMULTI202 - operationId: createDocument path: /documents method: POST media_type: application/xml name: orderWithFivePallets summary: Create an outbound XML order with five pallet items value: "\n TEST-EXAMPLE-ORDER-001\n kargo\n\ \ sf\n OUTBOUND\n TEST-EXAMPLE-SHIPMENT-001\n\ \ \n LPNABC\n SKU123\n 10\n CASE\n\ \ \n 00000000000379386070\n 10\n \n\ \ \n \n LPNABC\n SKU456\n 8\n\ \ CASE\n \n \n LPNDEF\n SKU789\n\ \ 12\n CASE\n \n \n LPNGHI\n\ \ SKU123\n 6\n CASE\n \n\ \ \n LPNJKL\n SKU999\n 15\n CASE\n\ \ \n\n" - operationId: createDocument path: /documents method: POST media_type: application/xml name: appendOrderItem summary: Append an order item value: "\n TEST-EXAMPLE-ORDER-001\n kargo\n\ \ sf\n OUTBOUND\n TEST-EXAMPLE-SHIPMENT-001\n\ \ APPEND\n \n LPNNEW\n \ \ SKUAPPEND\n 1\n UNIT\n \n\ \n" - operationId: createDocument path: /documents method: POST media_type: application/xml name: mergeOrderItemByLpnAndSku summary: Update or add an order item by LPN + SKU value: "\n TEST-EXAMPLE-ORDER-001\n kargo\n\ \ sf\n OUTBOUND\n TEST-EXAMPLE-SHIPMENT-001\n\ \ MERGE\n \n LPNABC\n \ \ SKU123\n 5\n CASE\n \n\ \n" - operationId: createDocument path: /documents method: POST media_type: application/xml name: deleteOrderItemByLpnAndSku summary: Delete an order item by LPN + SKU value: "\n TEST-EXAMPLE-ORDER-001\n kargo\n\ \ sf\n OUTBOUND\n TEST-EXAMPLE-SHIPMENT-001\n\ \ DELETE\n \n LPNABC\n \ \ SKU123\n \n\n" - operationId: createDocument path: /documents method: POST media_type: application/xml name: overwriteOrderItems summary: Replace all order items value: "\n TEST-EXAMPLE-ORDER-001\n kargo\n\ \ sf\n OUTBOUND\n TEST-EXAMPLE-SHIPMENT-001\n\ \ OVERWRITE\n \n LPNREPLACE001\n\ \ SKUREPLACE001\n 2\n UNIT\n\ \ \n \n LPNREPLACE002\n SKUREPLACE002\n 3\n\ \ CASE\n \n\n" - operationId: createDocument path: /documents method: POST media_type: application/xml name: shipmentWithMultipleOrders summary: Shipment with multiple orders value: "\n kargo\n sf\n OUTBOUND\n\ \ TEST-EXAMPLE-SHIPMENT-001\n \n TEST-EXAMPLE-ORDER-001\n\ \ \n LPNMULTI001\n SKUMULTI001\n 10\n\ \ CASE\n \n 00000000000379386070\n\ \ 10\n \n \n \n \n \ \ TEST-EXAMPLE-ORDER-002\n \n LPNMULTI002\n\ \ SKUMULTI002\n 8\n CASE\n\ \ \n \n\n" - operationId: createDocument path: /documents method: POST media_type: application/xml name: shipmentWithMultipleOrdersShipmentLevelStrategy summary: Shipment with multiple orders using shipment level strategy value: "\n kargo\n sf\n OUTBOUND\n\ \ TEST-EXAMPLE-SHIPMENT-001\n MERGE\n\ \ \n TEST-EXAMPLE-ORDER-001\n \n LPNMULTI101\n\ \ SKUMULTI101\n 10\n CASE\n\ \ \n \n \n TEST-EXAMPLE-ORDER-002\n \ \ \n LPNMULTI102\n SKUMULTI102\n 8\n\ \ CASE\n \n \n\n" - operationId: createDocument path: /documents method: POST media_type: application/xml name: shipmentWithMultipleOrdersOrderLevelStrategies summary: Shipment with multiple orders using order level strategies value: "\n kargo\n sf\n OUTBOUND\n\ \ TEST-EXAMPLE-SHIPMENT-001\n \n TEST-EXAMPLE-ORDER-001\n\ \ APPEND\n \n LPNMULTI201\n\ \ SKUMULTI201\n 4\n CASE\n\ \ \n \n \n TEST-EXAMPLE-ORDER-002\n \ \ DELETE\n \n LPNMULTI202\n\ \ SKUMULTI202\n \n \n\n" - operationId: createDocument path: /documents method: POST media_type: text/xml name: orderWithFivePallets summary: Create an outbound XML order with five pallet items value: "\n TEST-EXAMPLE-ORDER-001\n kargo\n\ \ sf\n OUTBOUND\n TEST-EXAMPLE-SHIPMENT-001\n\ \ \n LPNABC\n SKU123\n 10\n CASE\n\ \ \n 00000000000379386070\n 10\n \n\ \ \n \n LPNABC\n SKU456\n 8\n\ \ CASE\n \n \n LPNDEF\n SKU789\n\ \ 12\n CASE\n \n \n LPNGHI\n\ \ SKU123\n 6\n CASE\n \n\ \ \n LPNJKL\n SKU999\n 15\n CASE\n\ \ \n\n" - operationId: createDocument path: /documents method: POST media_type: text/xml name: appendOrderItem summary: Append an order item value: "\n TEST-EXAMPLE-ORDER-001\n kargo\n\ \ sf\n OUTBOUND\n TEST-EXAMPLE-SHIPMENT-001\n\ \ APPEND\n \n LPNNEW\n \ \ SKUAPPEND\n 1\n UNIT\n \n\ \n" - operationId: createDocument path: /documents method: POST media_type: text/xml name: mergeOrderItemByLpnAndSku summary: Update or add an order item by LPN + SKU value: "\n TEST-EXAMPLE-ORDER-001\n kargo\n\ \ sf\n OUTBOUND\n TEST-EXAMPLE-SHIPMENT-001\n\ \ MERGE\n \n LPNABC\n \ \ SKU123\n 5\n CASE\n \n\ \n" - operationId: createDocument path: /documents method: POST media_type: text/xml name: deleteOrderItemByLpnAndSku summary: Delete an order item by LPN + SKU value: "\n TEST-EXAMPLE-ORDER-001\n kargo\n\ \ sf\n OUTBOUND\n TEST-EXAMPLE-SHIPMENT-001\n\ \ DELETE\n \n LPNABC\n \ \ SKU123\n \n\n" - operationId: createDocument path: /documents method: POST media_type: text/xml name: overwriteOrderItems summary: Replace all order items value: "\n TEST-EXAMPLE-ORDER-001\n kargo\n\ \ sf\n OUTBOUND\n TEST-EXAMPLE-SHIPMENT-001\n\ \ OVERWRITE\n \n LPNREPLACE001\n\ \ SKUREPLACE001\n 2\n UNIT\n\ \ \n \n LPNREPLACE002\n SKUREPLACE002\n 3\n\ \ CASE\n \n\n" - operationId: createDocument path: /documents method: POST media_type: text/xml name: shipmentWithMultipleOrders summary: Shipment with multiple orders value: "\n kargo\n sf\n OUTBOUND\n\ \ TEST-EXAMPLE-SHIPMENT-001\n \n TEST-EXAMPLE-ORDER-001\n\ \ \n LPNMULTI001\n SKUMULTI001\n 10\n\ \ CASE\n \n 00000000000379386070\n\ \ 10\n \n \n \n \n \ \ TEST-EXAMPLE-ORDER-002\n \n LPNMULTI002\n\ \ SKUMULTI002\n 8\n CASE\n\ \ \n \n\n" - operationId: createDocument path: /documents method: POST media_type: text/xml name: shipmentWithMultipleOrdersShipmentLevelStrategy summary: Shipment with multiple orders using shipment level strategy value: "\n kargo\n sf\n OUTBOUND\n\ \ TEST-EXAMPLE-SHIPMENT-001\n MERGE\n\ \ \n TEST-EXAMPLE-ORDER-001\n \n LPNMULTI101\n\ \ SKUMULTI101\n 10\n CASE\n\ \ \n \n \n TEST-EXAMPLE-ORDER-002\n \ \ \n LPNMULTI102\n SKUMULTI102\n 8\n\ \ CASE\n \n \n\n" - operationId: createDocument path: /documents method: POST media_type: text/xml name: shipmentWithMultipleOrdersOrderLevelStrategies summary: Shipment with multiple orders using order level strategies value: "\n kargo\n sf\n OUTBOUND\n\ \ TEST-EXAMPLE-SHIPMENT-001\n \n TEST-EXAMPLE-ORDER-001\n\ \ APPEND\n \n LPNMULTI201\n\ \ SKUMULTI201\n 4\n CASE\n\ \ \n \n \n TEST-EXAMPLE-ORDER-002\n \ \ DELETE\n \n LPNMULTI202\n\ \ SKUMULTI202\n \n \n\n" - operationId: upsertSkuMaster path: /sku_master method: POST media_type: application/json name: batchUpsert summary: Upsert multiple SKUs value: business: kargo facility: sf skus: - sku_id: TEST-SKU-001 description: Test SKU 001 unit_of_measure: CASE unit_of_weight: LB alternate_sku_ids: - ALT-001 - UPC-001 cases_per_pallet: 55 cases_per_layer: 7 layers_per_pallet: 10 sku_metadata: source: local-test category: snack - sku_id: TEST-SKU-002 description: Test SKU 002 unit_of_measure: EACH cases_per_pallet: 43 cases_per_layer: 6 layers_per_pallet: 8 sku_metadata: source: local-test - operationId: upsertSkuMaster path: /sku_master method: POST media_type: application/json name: partialUpdate summary: Update only provided fields value: business: kargo facility: sf skus: - sku_id: TEST-SKU-001 description: Updated SKU description - operationId: upsertSkuMaster path: /sku_master method: POST media_type: application/xml name: batchUpsertXml summary: Upsert multiple SKUs with XML value: "\n kargo\n sf\n \n\ \ TEST-SKU-001\n Test SKU 001\n CASE\n\ \ LB\n ALT-001\n \ \ UPC-001\n 55\n \ \ 7\n 10\n \n\ \ local-test\n snack\n \n \n\ \ \n TEST-SKU-002\n Test SKU 002\n EACH\n\ \ 43\n 6\n 8\n\ \ \n local-test\n \n \n\n" - operationId: upsertSkuMaster path: /sku_master method: POST media_type: text/xml name: batchUpsertXml summary: Upsert multiple SKUs with XML value: "\n kargo\n sf\n \n\ \ TEST-SKU-001\n Test SKU 001\n CASE\n\ \ LB\n ALT-001\n \ \ UPC-001\n 55\n \ \ 7\n 10\n \n\ \ local-test\n snack\n \n \n\ \n" example_count: 28