Frequently Asked Questions

This section contains the FAQs which are divided into two categories Technical and Troubleshooting.
Please click the questions to see the answers.

General

What is GSX?
GSX is fundamentally different from other Apple service and parts ordering systems you may have used in the past. Please review the GSX User Guide and the GSX Training (see GSX section on AppleCare Service Source website) for more information.
What is the basic requirement to access GSX Web Services APIs?
To utilize the GSX API Web Services you must have a valid Apple Service Account.
Please contact API support to consume the New Generation WSDL
What is an Apple ID and what should I do to get one?
Apple ID is a personal identifier which allows you secure access to online Apple service tools, the Knowledge Base, and various Apple websites. If you have an Apple ID, use the same Apple ID within GSX. If you do not have an Apple ID, click the sign-up link on the GSX Log in page and create an Apple ID. It is critical that you consistently use the same Apple ID for your service operations. Apple may send confirmation and other essential communications to you via the email address associated with your Apple ID.
What should I do if I forget my Apple ID password?
If you forgot your password, you may reset it at iForgot. Ensure you're using the correct Apple ID.
What are the GSX approval requirements?
GSX has three different environments and you must apply for access to the desired environment. The environments are Integration Testing (GSXIT), Acceptance Testing (GSXUT), and Production (GSX). The following section describes how to apply for various GSX environments.
  • GSXIT: Please open the GSXIT URL and click If you do not have an Apple ID, get one here. That will show a form wherein you have to provide your personal details. After filling-up personal details, provide your Service account details in the next form and accept GSX Agreement. Click Submit to finish.
         Note:The user must maintain the ID details they are using for GSXIT environment.
  • GSXUT: Please open the GSXUT URL and click If you do not have an Apple ID, get one here. That will show a form wherein you have to provide your personal details. After filling-up personal details, provide your Service account details in the next form and accept GSX Agreement. Click Submit to finish.
         Note:The user must maintain the ID details they are using for GSXUT environment.
  • GSX: You must already have a valid apple connect account before starting with GSX approval process. Please login with you apple connect and the app will take you to 'Apply For Access' page wherein you provide your Service account details and accept GSX Agreement. Click Submit to finish.

GSX Testing Environments

What are the testing environments available in GSX?
We have two testing environments for development and acceptance testing, please see the descriptions below for more information.
  • GSXIT: The functionality/bug fixes are applied in GSXIT to verify the changes/fixes with respect to external interfaces.
  • GSXUT: After the functionality is verified and tested in GSXIT, changes are applied to GSXUT for verification from business users.

GSX Production Environment

When should I use GSX Production environment?
After you've tested and verified functionality in test and met requirements, apply for production access here.
What are approval requirements of GSX Production environment?
After a functionality/change is tested and verified in GSXUT, a change request is raised to incorporate it to production environment. The change request is an approval requirement for GSX Production environment. User can apply for production access here.

Technical

Why did Apple choose SOAP technology for GSX Web Services?
Simple Object Access Protocol (SOAP), a lightweight XML-based protocol for real-time data exchange, is the de-facto standard for Web Services. It is supported by most platforms and Web Services applications and can exchange nearly any structured data.
Where do I get GSX Web Services Definition Language (WSDL)?
Please visit API Artifacts page to download the WSDLs. This page is available available for specific user integration context; e.g. AASP users in Americas region, iPhone Carriers in APAC region etc.
How do I use the WSDL to communicate with GSX Web Services?
There are several third-party and open source tools that you can utilize in creating your web-services client applications, such as the two listed below.

AXIS-2: Apache Axis 2 is an implementation of the SOAP, which is available in both java and c++ . Please refer to http://ws.apache.org/axis2/ for more information.
Sun Metro: Sun Metro is a reference implementation of JAX-WS 2.0 specification and it provides a good set of APIs to invoke a web service. Please refer to https://metro.java.net/ for more information.
How do I securely connect to the GSX Web Services Servers?
GSX Web Services Server is configured to run and accept responses over HTTPS. To be able to talk to the GSX Web Services server, your application must make HTTPS requests over the Internet, not HTTP. 
What encoding is used by GSX Web Services?
GSX Web Services uses UTF-8 encoding in all requests and responses. Client application needs to handle the encoding. For example, French message RPR.CIN.006 will be as follows in the SOAP Response:

La date de r\216ception de l'unit\216 doit se trouver dans les 30 jours pr\216c\216dents la date d'aujourd'hui.

Client needs to handle the encoding so that the message is actually this:

La date de réception de l'unité doit se trouver dans les 30 jours précédents la date d'aujourd'hui.
What about Localization?
GSX Web Services support the same languages as GSX. In the Authenticate API, you are asked to submit a Language Code and based on which appropriate localization is applied. Please refer to the Language Code Section for a list of the Language codes.
Which entry fields are case sensitive?
All the fields are case sensitive. Please refer to sample request XMLs provided along with corresponding APIs to see how to pass the fields.
What do I need to know about Yes and No entry fields?
Yes and No entry fields include check boxes and pull-down menus similar to what you see in the GSX front-end application. Enter 'Y' to indicate 'Yes.' All other values will default to 'N' for 'No.'
What web services standards are supported by GSX WS?
GSX WS supports following standards to facilitate smoother integration between various platforms (Java EE, .Net etc).
1. SOAP 1.1
2. WSDL 1.1
3. WS-I basic profile 1.1
4. XSD Schema


Certificates

How does the certificate process work?
What information must be sent to Apple?
How do I request an Apple certificate?
How do I generate a CSR file?
What are the instructions to follow when generating the CSR?
What do I do with the client certificate that Apple provides?
What do I do once Apple confirms that our IP addresses are whitelisted?
What if I cannot use OpenSSL or Java Keytool?
What if I encounter an Error when Installing Certificates?
How do i troubleshoot issues in Certificates?


Troubleshooting

How do I verify my Web Services response data?
Please use the corresponding GSX environment (GSXIT, GSXUT or GSX) and check for the functionality you are testing.
What do I look for if it is my first time working with a new API, and I am not getting a correct response?
There are a number of items you can check before sending an email to the GSX Web Services Support Team:
  • Review the GSX Web Services API Documentation to see if there is information that might be pertinent to the issue at hand.
  • Ensure that you have downloaded the updated WSDL document from API Artifacts Tab. The API artifacts will be available for specific user integration context; e.g. AASP users in Americas region, iPhone Carriers in APAC region etc.
  • Try the Test GSX URL to verify that the test server is up and running.
  • Verify that you are testing via the test server.
  • Verify your https status and test certificate.
  • Verify your privilege in test environment. You will need the Web Services privilege as well as the privilege to that specific functionality.
  • Log the request in the Contact GSX Web Services support
Note: Do not attempt to use a new API in the Production environment until you have successfully completed your test via the GSX test server.
What should I do if my API suddenly stops working in the test environment?
If your API suddenly stops working in the test environment, something has changed. Please check any setup or logic changes that might have occurred on your client side. In addition you can send an email to the GSX Web Services Support Team.

Note: Do not attempt to use a new API in the Production environment until you have successfully completed your test via the GSX test server.
Why my legacy API suddenly stops working in the test environment?
Legacy API will not work once migrated to New Generation WSDL.
What should i do if i get an error code AUTH.UPL.003 in response?
Your soldTo was configured to use New generation wsdl.So your are not allowed to uses legacy wsdl.