Pular para o conteúdo
Documentação API Reference FAQ Changelog Status

Cart & Checkout

magento-2

Guest carts, customer carts, items, addresses, shipping, payment, totals, coupons e place order.

POST /rest/V1/guest-carts

Create an empty guest cart

Create an empty guest cart.

Retorna um cart id (masked) que você usa nas próximas chamadas.

GET /rest/V1/guest-carts/:cartId

Get guest cart

Get guest cart.

POST /rest/V1/guest-carts/:cartId/items

Add item to guest cart

Add item to guest cart.

PUT /rest/V1/guest-carts/:cartId/items/:itemId

Update guest cart item

Update guest cart item.

DELETE /rest/V1/guest-carts/:cartId/items/:itemId

Remove item from cart

Remove item from cart.

POST /rest/V1/guest-carts/:cartId/billing-address

Set billing address

Set billing address.

GET /rest/V1/guest-carts/:cartId/billing-address

Get billing address

Get billing address.

POST /rest/V1/guest-carts/:cartId/shipping-information

Set shipping address + method

Set shipping address + method.

GET /rest/V1/guest-carts/:cartId/shipping-methods

List available shipping methods

List available shipping methods.

POST /rest/V1/guest-carts/:cartId/estimate-shipping-methods-by-address-id

Estimate shipping by address

Estimate shipping by address.

POST /rest/V1/guest-carts/:cartId/estimate-shipping-methods

Estimate shipping by address data

Estimate shipping by address data.

GET /rest/V1/guest-carts/:cartId/payment-methods

List available payment methods

List available payment methods.

POST /rest/V1/guest-carts/:cartId/order

Place guest order

Place guest order.

Body: paymentMethod, opcional email.

GET /rest/V1/guest-carts/:cartId/totals

Get cart totals

Get cart totals.

POST /rest/V1/guest-carts/:cartId/totals-information

Get totals given an address

Get totals given an address.

PUT /rest/V1/guest-carts/:cartId/coupons/:couponCode

Apply coupon code

Apply coupon code.

GET /rest/V1/guest-carts/:cartId/coupons

Get applied coupon

Get applied coupon.

DELETE /rest/V1/guest-carts/:cartId/coupons

Remove coupon

POST /rest/V1/carts/mine Bearer

Create/get authenticated cart

Create/get authenticated cart.

Use customer token no header.

GET /rest/V1/carts/mine Bearer

Get authenticated cart

Get authenticated cart.

POST /rest/V1/carts/mine/items Bearer

Add item

PUT /rest/V1/carts/mine/items/:itemId Bearer

Update item

DELETE /rest/V1/carts/mine/items/:itemId Bearer

Remove item

POST /rest/V1/carts/mine/billing-address Bearer

Set billing address

Set billing address.

POST /rest/V1/carts/mine/shipping-information Bearer

Set shipping info

Set shipping info.

GET /rest/V1/carts/mine/shipping-methods Bearer

List shipping methods

List shipping methods.

GET /rest/V1/carts/mine/payment-methods Bearer

List payment methods

List payment methods.

PUT /rest/V1/carts/mine/payment-information Bearer

Set payment info + place order

Set payment info + place order.

Retorna o orderId.

PUT /rest/V1/carts/mine/order Bearer

Place order

GET /rest/V1/carts/mine/totals Bearer

Get totals

PUT /rest/V1/carts/mine/coupons/:couponCode Bearer

Apply coupon

DELETE /rest/V1/carts/mine/coupons Bearer

Remove coupon

GET /rest/V1/carts/search Bearer

Search carts (searchCriteria)

Search carts (searchCriteria).

Admin only.

GET /rest/V1/carts/:cartId Bearer

Get cart by ID (admin)

Get cart by ID (admin).

POST /rest/V1/carts Bearer

Create cart for customer (admin)

Create cart for customer (admin).

PUT /rest/V1/carts/:cartId/order Bearer

Place order (admin)

Place order (admin).