Skip to main content

Checkout for a specific product via DirectOrder or Punchout​

The method initiates a checkout for a specific product. If DirectOrder is enable, a reservation will be returned. Otherwise a Punchout will be initialized, the caller will get a redirect URL that the user can simply follow to initiate the punchout into Amazon. The caller must pass a callback URL in the request. That callback URL will later be used to send back the shopping cart in compliance with the SAP OCI protocol. Optionally, the caller can pass a shipment address in the request. The caller is strongly encouraged to do so. Otherwise, Amazon might fall back to the default address of the organization, and the delivery might be delayed or fail altogether.

Path Parameters
    id string required

    ID of the product to retrieve.

Request Body required
    callbackUrl required

    URL to be used when returning data to the caller. This URL will always be used, even in failure cases. In other words, we try everything to pass control back to the caller.

    name string

    Name of the user initiating the punchout request. This value is used in various places by Amazon, e.g. shipping notifications.

    shipTo object

    ShipTo address for Amazon. It is advised to pass an address here. If the caller doesn't pass an address here, Amazon may fallback to using the default address for the organization, which more often than not is a bad idea.

    addressId string

    Specifies an ID for the address. This attribute is used to support address codes for relationships that require ID references. It should not be the name of a company or person. It is intended for application-to-application integration.

    addressIdDomain string

    Specifies a code that represents the agency or organization responsible for the addressId numbering, e.g. DUNS or ILN. This code is required if there is a value in the addressId attribute.

    street string

    Specifies the street of the shipTo address.

    cityCode string

    Specifies a code for the city of the shipTo address. Notice that this is NOT the zip code! Find the zip code in the postalCode property.

    city string

    Specifies the city name of the shipTo address.

    stateCode string

    Specifies the state code of the shipTo address.

    state string

    Specifies the state of the shipTo address.

    postalCode string

    Specifies the postal code of the shipTo address.

    countryCode string

    Specifies the country code of the shipTo address.

    country string

    Specifies the country of the shipTo address.

Responses

Response to a checkout request.

Schema
    type string

    Possible values: [cxml-punchout, direct-order]

    Type of the checkout.

    punchout object

    Response in case of type is cxml-punchout

    redirectUrl string

    Redirect URL to follow for further processing.

Loading...