Home

Inpart Parts Order updates

How does the BMS receive order updates from Audatex?

• For each site you need to subscribe to a specific “topic” to get notifications of exports created in AEG for that site.

  You can see all your current subscriptions for your site using this Endpoint: Swagger URL for the Getting Subscriptions for a site

  To retrieve updates on Inpart order updates the topic is called PARTS.ORDER (this will combine notification for the PARTS.ORDER.CREATED and the PARTS.ORDER.UPDATED topics)

  

  Swagger URL for the Subscription Endpoint

  Example Response:

  { "SubscriptionId": "1abc9b9a-20e3-4870-8fa2-xxxxxxxxxxxx", "Topic": { "TopicCode": "PARTS.ORDER.CREATED", "Description": "A parts order was created." }, "CreatedAt": "2016-01-14T15:28:10.6843085Z" }

  This returns you a subscriptionId which you need to use each time you check for exports. The site is taken from the details of the user who is authenticated (so the bearer token used in making the API call contains that info). So for each site you would call that subscribe endpoint to get a site specific subscriptionId. A topic will only be subscribed once per site, subsequent subscriptions will return a HTTP code 409 - Already subscribed.

• Now you are subscribed, you can check for export notifications by calling the URL below with the subscriptionID from the previous step.

  Example Response:

  [ { "Topic": "PARTS.ORDER.CREATED", "CreatedAt": "2016-01-15T09:38:44.6871504Z", "ResourceUris": [ { "Type": "", "Value": "" } ] } ]
• When a notification becomes available you will be returned the endpoints which you then need to call to get the order status. The return would include links to the following Enpoint:

  Swagger URL for Getting parts order status

Pre-requisite:

• Authentication is set up. If you need more information on that, please refer to Developers' guide to accessing Audaconnect Resources

• You need permission for your application to use the BMS.PartOrders scope.
• If using the Assessment number and originator lookup the caller also needs Permission to use the BMS.Basic Scope.