GAgalileo-ft
Instant Issue

Move Card Inventory

Use the Move Card Inventory endpoint to reallocate card inventory to other entities. Specify the type of move to make with the type parameter.

post/moveCardInventory

Request

  • Base URL
    api-{corename}.{env}.gpsrv.com/intserv/4.0/ (relative, and the document’s source URL is not known)
  • URL
    api-{corename}.{env}.gpsrv.com/intserv/4.0/moveCardInventory
  • Auth
    none declared

Request body application/x-www-form-urlencoded

apiLoginstring required

Web service username, as provided by SoFi Tech Solutions. Pattern: Max 50 characters Example: "AbC123-9999"

apiTransKeystring required

Web service password, as provided by SoFi Tech Solutions. Pattern: Max 15 characters Example: "4sb62fh6w4h7w34g"

transactionIdstring required

Supply a globally unique ID to identify this endpoint request ("transaction"). Might be used for <a href="ref:idempotency#endpoints-that-use-transactionid-for-idempotency" target="_blank">idempotency</a>.. A UUID is preferred. Pattern: Maximum 60 characters Example: "9845dk-39fdk3fj3-4483483478"

prodIdinteger nullable

A unique product identifier from SoFi Tech Solutions. Pattern: Integer Example: 501

locationstring required

Identifier for the current location (location) as returned by the <a href="ref:post_createlocation" target="_blank">Create Location</a> endpoint. This value is also returned by the <a href="ref:post_getlocations" target="_blank">Get Locations</a> endpoint depending on the value of locationType when the location was created:

  • 0 — Returned in the location_id field
  • 1 — Returned in the provider_specified_id field

Pattern: Integer if locationType: 0; max 15 characters if locationType: 1 Example: "a455-3483"`

locationType0 | 1 required

Type of ID in location:

  • 0 — SoFi Tech Solutions location ID
  • 1 — Partner location ID

Pattern: Integer Example: 1

moveToLocationstring required

Identifier for the new location (location) as returned by the <a href="ref:post_createlocation" target="_blank">Create Location</a> endpoint. This value is also returned by the <a href="ref:post_getlocations" target="_blank">Get Locations</a> endpoint depending on the value of locationType when the location was created:

  • 0 — Returned in the location_id field
  • 1 — Returned in the provider_specified_id field

Pattern: Integer if moveToLocationType: 0; max 15 characters if moveToLocationType: 1 Example: "3"

moveToLocationType0 | 1 required

Type of location in moveToLocation:

  • 0 — SoFi Tech Solutions location ID
  • 1 — Provider location ID

Pattern: Integer Example: 1

type'PRN' | 'C' | 'B' | 'O' | 'PID' | 'P' required

The type of inventory move:

  • P — <glossary:CAD>
  • B — Bundle ID
  • O — Box ID
  • C — Case ID
  • PID — Product ID
  • PRN — Payment reference number Pattern: String Example: "P"
rangeStartstring required

Start of the ID range or a single ID. Pattern: Positive integer Example: "100"

rangeEndstring nullable

End of ID range. Omit this parameter if there is no range. Pattern: Positive integer Example: "200"

Example request

{
  "apiLogin": "AbC123-9999",
  "apiTransKey": "4sb62fh6w4h7w34g",
  "transactionId": "123e4567-e89b-12d3-a456-426614174000",
  "prodId": 501,
  "location": "a455-3483",
  "locationType": 1,
  "moveToLocation": "3",
  "moveToLocationType": 1,
  "type": "P",
  "rangeStart": "100",
  "rangeEnd": "200"
}

Response

status_codeinteger nullable required

The response status code. May return a string for some statuses.

statusstring nullable required

The condition of a process or response

processing_timenumber float nullable required

The time elapsed in processing the transaction

system_timestampstring date-time nullable required

A system generated timestamp

rtokenstring nullable required

A system-generated ID used for tracking

errorsstring[]

A list of errors generated while the request was processed

Changes

No recorded changes to this operation across all 2 revisions of this API.