giftCardsCreateOrderWithHttpInfo method
- String idempotencyKey, {
- GiftCardOrderRequest? giftCardOrderRequest,
- Future<
void> ? abortTrigger,
Order gift cards
Places a gift card order and returns the accepted order. Takes the same body as quote and needs the manage order permission (403 / 10003 without it). An Idempotency-Key header with a new UUID is required for every purchase: a retry with the same key and body returns the order already accepted, 202 / 12002 with Retry-After while it is still being accepted, and a changed body gives 409 / 12001. Order with the publicId a quote returned. Every price is recalculated: a current price above inputs.maxPrice gives 409 / 11002 at items[i].inputs.maxPrice before anything is charged. Each card of an item's quantity becomes its own order item; read the codes from the order routes or the order.fulfillment.updated webhook.
Note: This method returns the HTTP Response.
Parameters:
-
String idempotencyKey (required): UUID idempotency key for safe retries of this operation.
-
GiftCardOrderRequest giftCardOrderRequest:
Implementation
Future<Response> giftCardsCreateOrderWithHttpInfo(String idempotencyKey, { GiftCardOrderRequest? giftCardOrderRequest, Future<void>? abortTrigger, }) async {
// ignore: prefer_const_declarations
final path = r'/api/v1/b2b/giftcards/order';
// ignore: prefer_final_locals
Object? postBody = giftCardOrderRequest;
final queryParams = <QueryParam>[];
final headerParams = <String, String>{};
final formParams = <String, String>{};
headerParams[r'Idempotency-Key'] = parameterToString(idempotencyKey);
const contentTypes = <String>['application/json', 'text/json', 'application/*+json'];
return apiClient.invokeAPI(
path,
'POST',
queryParams,
postBody,
headerParams,
formParams,
contentTypes.isEmpty ? null : contentTypes.first,
abortTrigger: abortTrigger,
);
}