Swap products in order (0.1.0)

Download OpenAPI specification:Download

team-order-management: team-order-management@newstore.com

Use these APIs to swap products in an existing order.

product-swaps

Use this resource to initiate and complete swapping of items on an order.

Initiate swapping of products in an existing order.

Request Body schema: application/json

required

Array of objects non-empty

Array (non-empty)

sales_order_item_uuid required	string = 36 characters The UUID of the sales order item that should be swapped.
product_id required	string non-empty The SKU of the new product.

Responses

Request samples

Payload

Content type

application/json

Swaps the product of one sales order item.

{"swaps": [{"sales_order_item_uuid": "d34438a4-ddfb-441d-b85a-98fe2420acac",
"product_id": "10000023"
}
]
}

Response samples

200
400
404
500

Content type

application/json

The swapped item and the order status after the swap was initiated.

{"swaps": [{"uuid": "fcd4af6f-886a-42c2-9349-7d14dc49f83e",
"product_sku": "11111111",
"product_name": "Blue Bag",
"shipping_weight_value": "1",
"shipping_weight_unit": "kg",
"product_hts_number": "76546789",
"country_of_origin": "De",
"material": "Leather",
"schedule_b": "",
"product_attributes": { },
"external_identifier": "8765478",
"epc_list": [ ],
"product_id": "110000023",
"old_item_uuid": "d34438a4-ddfb-441d-b85a-98fe2420acac",
"old_product_id": "11111111"
}
],
"order_status": "routing"
}

Complete the swapping of products in an existing order.

Request Body schema: application/json

swap_status required	string Enum: "swapped" "failed" The desired status for the swapped items. The swap_status can be swapped or failed.
sales_order_item_uuids required	Array of strings non-empty [ items = 36 characters ]

Responses

Request samples

Payload

Content type

application/json

Marks the swap of one sales order item as swapped.

{"swap_status": "swapped",
"sales_order_item_uuids": ["d34438a4-ddfb-441d-b85a-98fe2420acac"
]
}

Response samples

400
500

Content type

application/problem+json

Example

Validation error

The request payload failed validation.

{"error_code": "bad_request",
"message": "Value provided should be a string.",
"request_id": "ec2f3c9bb016ba971bf6074098363"
}