Jump to

• Request
• Response

Update a subscription order transaction

patch

/crmRestApi/resources/11.13.18.05/subscriptionOrderTransactions/{TransactionNumber}

Request

Path Parameters

• TransactionNumber(required): string
  The alternate identifier of the transaction.

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• BatchId: integer (int64)
  The unique identifier of the batch partition.
• SalesOrderFulfillLineId: integer (int64)
  The fulfillment line identifier in Order Management.
• SalesOrderId: integer (int64)
  The sales order identifier in Order Management.
• SalesOrderLineId: integer (int64)
  The sales order line identifier in Order Management.
• SubscriptionId: integer (int64)
  The unique identifier of the subscription in Subscription Management.
• SubscriptionProductId: integer (int64)
  The subscription product identifier in Subscription Management.
• TransactionId: integer (int64)
  The unique identifier of the transaction.
• TransactionNumber: string
  Title: Transaction Number

  Maximum Length: 120

  The alternate identifier of the transaction.
• TransactionStatus: string
  Title: Status

  Maximum Length: 30

  The current status of the transaction. Possible values are NEW, PENDING, PROCESSED, ERROR.
• TransactionType: string
  Title: Transaction Type

  Maximum Length: 30

  The type of order management transaction. Possible values are ORA_CREATE, ORA_AMEND, ORA_CLOSE.

{
    "type":"object",
    "properties":{
        "BatchId":{
            "type":"integer",
            "description":"The unique identifier of the batch partition.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            }
        },
        "SalesOrderFulfillLineId":{
            "type":"integer",
            "description":"The fulfillment line identifier in Order Management.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            }
        },
        "SalesOrderId":{
            "type":"integer",
            "description":"The sales order identifier in Order Management.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            }
        },
        "SalesOrderLineId":{
            "type":"integer",
            "description":"The sales order line identifier in Order Management.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            }
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription in Subscription Management.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            }
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The subscription product identifier in Subscription Management.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            }
        },
        "TransactionId":{
            "type":"integer",
            "description":"The unique identifier of the transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            }
        },
        "TransactionNumber":{
            "title":"Transaction Number",
            "maxLength":120,
            "type":"string",
            "description":"The alternate identifier of the transaction.",
            "nullable":false
        },
        "TransactionStatus":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The current status of the transaction. Possible values are NEW, PENDING, PROCESSED, ERROR.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TransactionType":{
            "title":"Transaction Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of order management transaction. Possible values are ORA_CREATE, ORA_AMEND, ORA_CLOSE.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : subscriptionOrderTransactions-item-response

Type: object

Show Source

• BatchId: integer (int64)
  The unique identifier of the batch partition.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the record was created.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrderNumber: string
  Title: Order Number

  Read Only: true

  Maximum Length: 50

  The user identifiable order number.
• SalesOrderFulfillLineId: integer (int64)
  The fulfillment line identifier in Order Management.
• SalesOrderId: integer (int64)
  The sales order identifier in Order Management.
• SalesOrderLineId: integer (int64)
  The sales order line identifier in Order Management.
• SubscriptionId: integer (int64)
  The unique identifier of the subscription in Subscription Management.
• SubscriptionNumber: string
  Title: Subscription Number

  Read Only: true

  The user identifiable subscription number.
• SubscriptionProductId: integer (int64)
  The subscription product identifier in Subscription Management.
• TransactionId: integer (int64)
  The unique identifier of the transaction.
• TransactionNumber: string
  Title: Transaction Number

  Maximum Length: 120

  The alternate identifier of the transaction.
• TransactionStatus: string
  Title: Status

  Maximum Length: 30

  The current status of the transaction. Possible values are NEW, PENDING, PROCESSED, ERROR.
• TransactionType: string
  Title: Transaction Type

  Maximum Length: 30

  The type of order management transaction. Possible values are ORA_CREATE, ORA_AMEND, ORA_CLOSE.

{
    "type":"object",
    "properties":{
        "BatchId":{
            "type":"integer",
            "description":"The unique identifier of the batch partition.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "OrderNumber":{
            "title":"Order Number",
            "maxLength":50,
            "type":"string",
            "description":"The user identifiable order number.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesOrderFulfillLineId":{
            "type":"integer",
            "description":"The fulfillment line identifier in Order Management.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "SalesOrderId":{
            "type":"integer",
            "description":"The sales order identifier in Order Management.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "SalesOrderLineId":{
            "type":"integer",
            "description":"The sales order line identifier in Order Management.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription in Subscription Management.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "SubscriptionNumber":{
            "title":"Subscription Number",
            "type":"string",
            "description":"The user identifiable subscription number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"The subscription product identifier in Subscription Management.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "TransactionId":{
            "type":"integer",
            "description":"The unique identifier of the transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "TransactionNumber":{
            "title":"Transaction Number",
            "maxLength":120,
            "type":"string",
            "description":"The alternate identifier of the transaction.",
            "nullable":false,
            "x-queryable":true
        },
        "TransactionStatus":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The current status of the transaction. Possible values are NEW, PENDING, PROCESSED, ERROR.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TransactionType":{
            "title":"Transaction Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of order management transaction. Possible values are ORA_CREATE, ORA_AMEND, ORA_CLOSE.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top