Skip to content

Step 18. Create a shipment [Web API]

Tomash Khamlai edited this page Jun 29, 2018 · 15 revisions

Endpoint
GET V1/inventory/source-selection-algorithm-list

Headers

Content-Type: application/json
Authorization: Bearer <admin_token>

Payload
None

Response

[                                                                                                                                                                                                      
   {                                                                                                                                                                                                   
      "title" : "Source Priority",                                                                                                                                                                     
      "code" : "priority",                                                                                                                                                                             
      "description" : "Algorithm which provides Source Selections based on predefined priority of Source"                                                                                              
   }                                                                                                                                                                                                   
]

Complete cURL request

curl -X GET "$endpoint/V1/inventory/source-selection-algorithm-list" \
-H 'Content-Type: application/json' \
-H "Authorization: Bearer $admin_token" | json_pp

Endpoint
POST V1/inventory/source-selection-algorithm-result

Headers

Content-Type: application/json
Authorization: Bearer <admin_token>

Payload

{
	"inventoryRequest": {
		"stock_id": 0,
		"items": [{
			"sku": "Simple Product MSM 1",
			"qty": 12
		}]
	},
	"algorithmCode": "priority"
}

Response

Complete cURL request

curl -X POST "$endpoint/V1/inventory/source-selection-algorithm-result" \
-H 'Content-Type: application/json' \
-H "Authorization: Bearer $admin_token" \
-d '{"inventoryRequest":{"stock_id":0,"items":[{"sku":"Simple Product MSM 1","qty":12}]},"algorithmCode":"priority"}'

Create a shipment with Simple Product
Create a shipment with Configurable Product
Create a shipment with Downloadable Product
Create a shipment with Virtual Product

◀️ Previous Step 📖 Table of Contents Next Step ▶️

MSI Documentation:

  1. Technical Vision. Catalog Inventory
  2. Installation Guide
  3. List of Inventory APIs and their legacy analogs
  4. MSI Roadmap
  5. Known Issues in Order Lifecycle
  6. MSI User Guide
  7. DevDocs Documentation
  8. User Stories
  9. User Scenarios:
  10. Technical Designs:
  11. Admin UI
  12. MFTF Extension Tests
  13. Weekly MSI Demos
  14. Tutorials
Clone this wiki locally