Checkout API Skill
vtex-local-checkout-api
Endpoints
| Method | Path | Description |
|---|---|---|
POST | /api/checkout/pub/orderForms/simulation | |
GET | /api/checkout/pub/orderForm | Cart simulation |
GET | /api/checkout/pub/orderForm/{orderFormId} | Get current or create a new cart |
POST | /api/checkout/pub/orderForm/{orderFormId}/items/removeAll | Get cart information by ID |
GET | /checkout/changeToAnonymousUser/{orderFormId} | Remove all items from shopping cart |
POST | /api/checkout/pub/orderForm/{orderFormId}/items/update | Remove all personal data from shopping cart |
POST | /api/checkout/pub/orderForm/{orderFormId}/items | Update cart items |
PATCH | /api/checkout/pub/orderForm/{orderFormId}/items | Add cart items |
PUT | /api/checkout/pub/orderForm/{orderFormId}/items/{itemIndex}/price | Handle cart items |
DELETE | /api/checkout/pub/orderForm/{orderFormId}/items/{itemIndex}/price | Change price of an SKU in a cart |
PATCH | /api/checkout/pub/orderForm/{orderFormId}/profile | Delete manual price of an SKU in a cart |
GET | /api/checkout/pub/profiles | Ignore profile data on checkout |
POST | /api/checkout/pub/orderForm/{orderFormId}/attachments/clientProfileData | Get client profile by email |
POST | /api/checkout/pub/orderForm/{orderFormId}/attachments/shippingData | Add client profile |
POST | /api/checkout/pub/orderForm/{orderFormId}/attachments/clientPreferencesData | Add shipping address and select delivery option |
POST | /api/checkout/pub/orderForm/{orderFormId}/attachments/marketingData | Add client preferences |
POST | /api/checkout/pub/orderForm/{orderFormId}/attachments/paymentData | Add marketing data |
POST | /api/checkout/pub/orderForm/{orderFormId}/items/{itemIndex}/attachments/{attachmentName} | Add payment data |
DELETE | /api/checkout/pub/orderForm/{orderFormId}/items/{itemIndex}/attachments/{attachmentName} | Add item attachment |
POST | /api/checkout/pub/orderForm/{orderFormId}/attachments/subscriptionData | Remove item attachment |
DELETE | /api/checkout/pub/orderForm/{orderFormId}/attachments/subscriptionData | Add item subscription attachment |
POST | /api/checkout/pub/orderForm/{orderFormId}/attachments/merchantContextData | Remove item subscription attachment |
POST | /api/checkout/pub/orderForm/{orderFormId}/attachments/invoiceData | Add merchant context data |
PUT | /api/checkout/pub/orderForm/{orderFormId}/customData/{appId} | Attach invoice data |
PUT | /api/checkout/pub/orderForm/{orderFormId}/customData/{appId}/{appFieldName} | Set multiple custom field values |
DELETE | /api/checkout/pub/orderForm/{orderFormId}/customData/{appId}/{appFieldName} | Set single custom field value |
PUT | /api/checkout/pub/orderForm/{orderFormId}/customFields | Remove single custom field value |
PUT | /api/checkout/pub/orderForm/{orderFormId}/customFields/order | Batch add custom fields |
PUT | /api/checkout/pub/orderForm/{orderFormId}/customFields/item/{itemId} | Add order custom field |
DELETE | /api/checkout/pub/orderForm/{orderFormId}/customFields/item/{itemId} | Add item custom field |
Install as Skill
Use this API as a Claude Code skill for instant agent access.
CLI Install
lapsh skill-install vtex-local-checkout-api
Downloads and installs to ~/.claude/skills/vtex-local-checkout-api/
Recent Versions (1)
1.0(2026-06-27)