Sanggunian ng API
commerce
22 mga endpoint sa lugar na ito. Ang bawat isa ay may sariling pahina kasama ang mga parameter nito, ang tugon nito, at isang kahilingan na maaari ninyong patakbuhin.
| Paraan | Path | Ang ginagawa nito | Pahintulot |
|---|---|---|---|
| POST | /v1/carts | Open a shopping cart. | billing.payment.manage |
| POST | /v1/carts/adopt | Carry a guest basket into the signed-in account. | billing.payment.manage |
| GET | /v1/carts/{cartId} | Get a cart. | billing.payment.manage |
| POST | /v1/carts/{cartId}/checkout | Check out a cart — place and charge an order. | billing.payment.manage |
| POST | /v1/carts/{cartId}/lines | Add a line to a cart. | billing.payment.manage |
| DELETE | /v1/carts/{cartId}/lines/{lineId} | Remove a line from a cart. | billing.payment.manage |
| GET | /v1/order/config/{planCode} | Everything a signed-in customer configures for one plan. | billing.view |
| GET | /v1/orders | List orders in scope. | billing.view |
| GET | /v1/orders/{orderId} | Get an order. | billing.view |
| POST | /v1/orders/{orderId}/customer-action | Reopen the checkout for a payment that is waiting on the customer. | billing.payment.manage |
| POST | /v1/orders/{orderId}/pay | Pay an order that was placed but not charged. | billing.payment.manage |
| GET | /v1/orders/{orderId}/payment-options | The payment gateways this order may be settled on. | billing.payment.manage |
| POST | /v1/orders/{orderId}/payment-step-abandoned | Tell staff the customer left an in-place payment step without paying. | billing.payment.manage |
| POST | /v1/orders/{orderId}/paypal | Open a PayPal order for the browser to complete. | billing.payment.manage |
| POST | /v1/orders/{orderId}/paypal/capture | Capture a PayPal order the buyer completed. | billing.payment.manage |
| GET | /v1/orders/{orderId}/refund-eligibility | Preview an order's refund eligibility. | billing.view |
| POST | /v1/orders/{orderId}/refund-request | Request a refund for an order. | billing.payment.manage |
| GET | /v1/payment-options | The payment rails a purchase in this currency may be settled on. | billing.payment.manage |
| GET | /v1/refund-requests | List the organization's refund requests. | billing.view |
| GET | /v1/refund-requests/{refundRequestId} | Get a refund request. | billing.view |
| POST | /v1/refund-requests/{refundRequestId}/approve | Approve a pending refund request (staff). | billing.refund |
| POST | /v1/refund-requests/{refundRequestId}/reject | Reject a pending refund request (staff). | billing.refund |