Integration Points

There are 3 core integration points for a standard integration.

Get Authorization Token

This needs to be called prior to invoking any API call.

Details: https://api.partsfinder.com/Home/Authentication

Data Required:

  • username

    • This is the user’s email or user id

  • company id

  • subscription id

  • password

Get SSO URL

Using the above returned Authorization Token, this will get the user the SSO URL to get into the PartsSource Platform.

Details: https://api.partsfinder.com/Services/IntegrationService/GetPartsFinderUri

Data Required:

  • bearer token in header

Data can be appended (as query string parameters) to the returned SSO URL to pass additional information automatically into the PartsSource session

Work Order #

Work order number that refers to what the user is working on

Receiving

?wo=

Asset ID

The ID of the asset that needs parts

Receiving

?asset=

Serial Number

The serial number for the asset that needs parts

Receiving

?serial=

CMMS ID

Unique identifier for the corresponding CMMS record for that line ite,

Receiving

?wo_id=

Event Messaging Service

This is the service that will transmit JSON messages to the client’s CMMS endpoint. The data below will be transmitted for the state changes / events that occur on the transaction.

Data Sent by PartsSource

Data Element

Description

State in CMMS

Quantity

Quantity of parts ordered on the line item

Order Quantity

Reference ID

PartsSource Reference ID on the line item - this is the most important tracking ID for finding orders in PartsSource

Correlation ID

Part Number

PartsSource Part number for the part ordered

Part Number

Description

Description of the part ordered

Short Description

Manufacturer

Manufacturer of the part ordered

Manufacturer

Manufacturer ID

PartsSource ID of the part manufacturer

Manufacturer ID

Facility Name

Name of the facility that the part is needed for

Facility Name

Order Number

PartsSource order number

Correlation ID

Is Exchange Required

For some parts, the broken part is required to be sent back as part of the pricing agreement. In these cases, this boolean will be true

Is Exchange Required

Condition

Condition description of the part (e.g. OEM, OEM Replacement, Refurbished, Outright, Exchange, etc)

Condition

Unit Price

The price of the part

Unit Cost

Tax

The tax assessed in the order

Tax

Ship Cost

Shipping cost of the part

Ship Cost

Customer PO

The PO number that the customer has provided

External PO Number

Data Transmission Events

  • Ordering Events

    • Submit for Approval

    • Submit for PO

    • Awaiting PO

    • Purchase

    • Receive PO from EDI, Email, parser

    • API (order close event)

  • Order Processing Events

    • Backorder Set

    • Backorder update

    • Line Split

    • No-Sale (cancelled)

    • Warranty line item created

  • Shipping Events:

    • Order Shipped

    • Send tracking info

    • Order Delivered

  • Return/Exchange Processing [NEW]

    • RGA Started (RGA: return goods authorization)

    • RGA Complete

Last updated