Disclaimer: This website requires JavaScript to function properly. Some features may not work as expected. Please enable JavaScript in your browser settings for the best experience.

Dev GuideAPI Reference
Dev GuideAPI ReferenceUser GuideLegal TermsGitHubDev CommunityOptimizely AcademySubmit a ticketLog In
Dev Guide

SetupRequestHandler API handler

Describes the Setup Request handler.

OrderHandlerDescription
500ValidateRequestUses the ValidateXml pipeline to validate the incoming cXml request.
600CreatePunchOutSetupRequestCreates a new PunchOutSetupRequest.
700CreatePunchOutSessionUses the CreatePunchOutSession pipeline to create a PunchOutSession.
800ValidateCredentialsUses the ValidateCredentials pipeline to validate the credentials of the incoming cXml request.
900CreateCustomerOrderBypasses handler if PunchOutSession.PunchOutSessionMode is not create. Uses the CreateSetupRequestCustomerOrder to create a CustomerOrder.
1000UpdateCreatedPunchOutSessionBypasses handler if PunchOutSession.PunchOutSessionMode is not create. Updates the PunchOutSession with values from the CustomerOrder.
1100UpdateExistingPunchOutSessionBypasses handler if PunchOutSession.PunchOutSessionMode is create or PunchOutSession.PunchOutSessionItemIns count is zero. Uses the first PunchOutSession.PunchOutSessionItemIn.SupplierPartAuxiliaryId to lookup existing PunchOutSession. Updates the PunchOutSession with values from the CustomerOrder.
1200CreateResponseCreates a cXml response message and sets it to the result.